Skip to content

Commit

Permalink
Update CONTRIBUTORS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bsavitzky authored Jan 12, 2024
1 parent 5b88a89 commit 0688b0b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ There are many ways to contribute to py4DSTEM, including:

* **Documentation:** All code should be well-documented, and use Numpy style docstrings. Use docstrings to document functions and classes, add comments to explain complex code both blocks and individual lines, and use informative variable names.

* **Testing:** Ideally all new code should be accompanied by tests using pyTest framework; but at the least we require examples of old and new behaviour caused by the PR. For bug fixes this can be a block of code which currently fails and works with the proposed changes. For new workflows or extensive feature additions,we'd prefer a Jupyter notebook demonstrating the changes for an entire workflow i.e. from loading the input data and saving any processed results.
* **Testing:** Ideally all new code should be accompanied by tests using pyTest framework; at the least we require examples of old and new behaviour caused by the PR. For bug fixes this can be a block of code which currently fails and works with the proposed changes. For new workflows or extensive feature additions, please also include a Jupyter notebook demonstrating the changes for an entire workflow i.e. from loading the input data to visualizing and saving any processed results.

* **Dependencies:** Adding dependencies should be done so thoughtfully. Prioritize adding dependencies that are actively maintained, have permissive installation requirements, and are accessible through both pip and conda.
* **Dependencies:** New dependencies represent a significant change to the package, and any PRs which add new dependencies will require discussion and agreement from the development team. If a new dependency is required, please prioritize adding dependencies that are actively maintained, have permissive installation requirements, and are accessible through both pip and conda.

### Pull Requests

Expand Down

0 comments on commit 0688b0b

Please sign in to comment.