Skip to content

Commit 57cdd04

Browse files
authored
Revise CONTRIBUTING.md for clarity and emphasis
Updated contribution guidelines to clarify project structure and emphasize the importance of descriptive commit messages.
1 parent d526a40 commit 57cdd04

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
# Contributing to PyNumDiff
22

3-
Thank you for your interest in contributing to PyNumDiff! This document provides guidelines and instructions for contributing to the project.
4-
5-
## Project Structure
6-
7-
- `pynumdiff/` - Main source code, tests in subfolder
8-
- `notebooks/` - Jupyter notebook examples and experiments
9-
- `docs/` - Documentation source files
10-
- `.github/workflows/` - GitHub Actions CI configuration
3+
Thank you for your interest in contributing to PyNumDiff! To get a sense of the project structure, poke around, and digest the pertinent READMEs.
114

125
## Opening Issues
136

@@ -49,6 +42,8 @@ Some issues will require going and digging into alternative methods of different
4942

5043
### Contributing Code
5144

45+
Bear in mind that smaller, focused PRs are generally easier to review. We encourage descriptive commit messages that explain what changed and why. Long, detailed commit messages are appreciated as they help others understand the project's history.
46+
5247
1. Fork the repository (button on the main repo page)
5348
2. Clone down your version (`git clone https://github.com/YOUR_USERNAME/PyNumDiff.git`)
5449
3. Set its upstream to point to this version so you can easily pull our changes (`git remote add upstream https://github.com/florisvb/PyNumDiff.git`)
@@ -63,8 +58,6 @@ Some issues will require going and digging into alternative methods of different
6358

6459
No strict coding style is enforced, although we consider docstrings to be very important. The project uses `pylint` for code quality checks (`pylint pynumdiff`), because we're trying to meet a high bar so the JOSS (Journal of Open Source Software) likes us.
6560

66-
Bear in mind that smaller, focused PRs are generally easier to review. We encourage descriptive commit messages that explain what changed and why. Long, detailed commit messages are appreciated as they help others understand the project's history.
67-
6861
Once you push, GitHub Actions will kick off our continuous integration job, which runs the tests, including:
6962
- `test_diff_methods`: Broadly tests for correctness and ability to actually differentiate
7063
- `test_utils`: Contains tests of supporting and miscellaneous functionality like simulations and evaluation metrics

0 commit comments

Comments
 (0)