Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (46 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

79 lines (46 loc) · 2.12 KB
Raw

CONTRIBUTING.md

Thank you for your interest in contributing to whynot!

Setup

To contribute to whynot, you'll need to set up a local development environment. Here's how:

  1. Fork the repository: Fork the whynot repository to your GitHub account.
  2. Clone the repository: Clone the forked repository to your local machine.
git clone https://github.com/{your_github_username}/whynot.git
  1. Create a new branch: Create a new branch for your feature.
git checkout -b feature-branch-name
  1. Install the dependencies: Currently we support pypi based packages. You can install these with the following command:
pip install -r requirements.txt

  1. Make changes: Make your proposed changes to the codebase.

  2. Run tests: Ensure that all tests pass.

pytest
  1. Check formatting: CI rejects code that is not formatted with black, so run the linters before pushing. black whynot tests reformats in place.
sh lint.sh
  1. Push changes: If everything looks good, push your changes to your fork.
git add .
git commit -m "Brief description of changes"
git push origin feature-branch-name
  1. Open a pull request: Go back to your forked repository on GitHub, and open a new pull request to the main whynot repository.

Code Standards

Code is formatted with black and docstrings follow the numpy convention, checked with pydocstyle. Both run in CI via lint.sh, so a pull request that has not been formatted will fail.

Tests

Before submitting your changes, make sure all existing tests pass. If you've added a new feature, please include tests that cover your feature.

Pull Requests

When you open a pull request, please be as clear and descriptive as possible in the title and the description.

Reporting Issues

If you're facing any problems or have a feature request, please open an issue about it on GitHub. We appreciate your feedback and we'll respond as soon as we can.

Questions?

If you have any queries or need further clarification, please feel free to reach out to us.