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.rst
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,10 @@ Submit contributions as a pull request on GitHub.
9
9
10
10
Standards
11
11
---------
12
-
13
-
All contributions must be PEP complaint.
14
-
All modules, classes, and functions must have Sphinx style doc strings.
15
-
All parameters and variables should have type annotations.
16
-
A reasonable amount of code block documentation is expected as well.
12
+
- All contributions must be PEP complaint.
13
+
- All modules, classes, and functions must have Sphinx style doc strings.
14
+
- All parameters and variables should have type annotations.
15
+
- A reasonable amount of code block documentation is expected as well.
17
16
18
17
Tests should be written first before implementing functionality. See https://en.wikipedia.org/wiki/Test-driven_development
19
18
@@ -25,15 +24,19 @@ To create a new release for pypi and conda:
25
24
26
25
1. Clone this repository
27
26
2. Make sure all tests pass first by running `./setup.py test`
28
-
3. Use git or the GitHub interface to tag the repository with the next version. Follow symantic versioning rules https://semver.org/:
27
+
3. Use git or the GitHub interface to tag the repository with the next version. Precede the version number with a 'v'. Follow symantic versioning rules https://semver.org/:
29
28
30
29
Given a version number MAJOR.MINOR.PATCH, increment the:
30
+
31
31
MAJOR version when you make incompatible API changes,
32
+
32
33
MINOR version when you add functionality in a backwards compatible manner, and
34
+
33
35
PATCH version when you make backwards compatible bug fixes.
34
36
35
37
4. Create a release via the GitHub interface for the new tag.
36
38
5. Build the package by running `./setup.py build sdist`
37
39
6. Upload the new package to pypi by running `twine upload -u brinkmanlab dist/<file with latest version number>.tar.gz`
38
40
39
41
Bioconda will detect the upload and automatically update its recipe. A Bioconda maintainer will manually approve the update.
0 commit comments