You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-10Lines changed: 3 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,6 @@
1
1
# Contributing to PyNumDiff
2
2
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.
11
4
12
5
## Opening Issues
13
6
@@ -49,6 +42,8 @@ Some issues will require going and digging into alternative methods of different
49
42
50
43
### Contributing Code
51
44
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
+
52
47
1. Fork the repository (button on the main repo page)
53
48
2. Clone down your version (`git clone https://github.com/YOUR_USERNAME/PyNumDiff.git`)
54
49
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
63
58
64
59
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.
65
60
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
-
68
61
Once you push, GitHub Actions will kick off our continuous integration job, which runs the tests, including:
69
62
-`test_diff_methods`: Broadly tests for correctness and ability to actually differentiate
70
63
-`test_utils`: Contains tests of supporting and miscellaneous functionality like simulations and evaluation metrics
0 commit comments