Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RoyElkabetz authored Jul 20, 2024
1 parent c8e2a60 commit b4391e0
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ We use github to host code, to track issues and feature requests, as well as acc
## All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

1. Fork the repo and create your branch from `dev` (not `main`).
2. If you've added code that should be tested, add tests to `tests/test_main.py`.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes by install and run `pytest`.
1. Fork the repo and create your branch from `dev` (not `main`).
2. Install locally using `requirements-dev.txt`.
3. If you've added code that should be tested, add tests to `tests/test_main.py`.
4. If you've changed APIs, update the documentation.
5. Ensure the test suite passes by install and run `pytest`.
6. Issue that pull request!

## Any contributions you make will be under the MIT Software License
Expand Down

0 comments on commit b4391e0

Please sign in to comment.