Skip to content

Commit 4f180f1

Browse files
author
Nolan Woods
committed
Update CONTRIBUTING
1 parent 19b6ff5 commit 4f180f1

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

CONTRIBUTING.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,10 @@ Submit contributions as a pull request on GitHub.
99

1010
Standards
1111
---------
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.
1716

1817
Tests should be written first before implementing functionality. See https://en.wikipedia.org/wiki/Test-driven_development
1918

@@ -25,15 +24,19 @@ To create a new release for pypi and conda:
2524

2625
1. Clone this repository
2726
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/:
2928

3029
Given a version number MAJOR.MINOR.PATCH, increment the:
30+
3131
MAJOR version when you make incompatible API changes,
32+
3233
MINOR version when you add functionality in a backwards compatible manner, and
34+
3335
PATCH version when you make backwards compatible bug fixes.
3436

3537
4. Create a release via the GitHub interface for the new tag.
3638
5. Build the package by running `./setup.py build sdist`
3739
6. Upload the new package to pypi by running `twine upload -u brinkmanlab dist/<file with latest version number>.tar.gz`
3840

3941
Bioconda will detect the upload and automatically update its recipe. A Bioconda maintainer will manually approve the update.
42+

0 commit comments

Comments
 (0)