Skip to content

Commit 9483179

Browse files
committed
Updates to README
1 parent b23ea1e commit 9483179

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

+23
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ we follow in the documentation
3838
majority of the documentation is generated from python docstrings written using
3939
NumPy documentation format.
4040

41+
The changelogs can be found in docs/changelog/. There is a changelog file for
42+
each released version of the software.
43+
4144
## Tests
4245

4346
Simphony uses the [pytest](https://docs.pytest.org/en/latest/) testing
@@ -63,9 +66,29 @@ repeatedly until no installations remain) and running the following commands
6366
python3 setup.py sdist bdist_wheel
6467
pip install dist/simphony-[VERSION].tar.gz
6568
```
69+
## Contributing
70+
71+
All contributions and new features or bug fixes should be worked on in forks
72+
or branches of the repository. Issues should be opened, and pull requests
73+
should reference and [close those issues](https://help.github.com/en/articles/closing-issues-using-keywords).
74+
This is good versioning and documentation practice.
6675

6776
## Maintainers
6877

78+
Remember that all changes are to be integrated through pull requests. Development
79+
work should be done in branches or forks of the repository. Once implemented
80+
(and tested on their own), these pull requests should be merged into the
81+
"master" branch for full testing with the whole program. Each time the package
82+
is released on PyPI, the package should have a pull request opened to its
83+
corresponding release branch (release-MAJOR.MINOR.x). The hierarchy is then
84+
as follows:
85+
86+
- release.* (stable branch)
87+
- master (integration and final testing)
88+
- feature-name (feature development and bug fixes)
89+
90+
Even if you are the lone developer, we follow the methodology [here](https://softwareengineering.stackexchange.com/a/294048).
91+
6992
Be sure to update the version number manually before pushing each new version
7093
to PyPI. Also be sure to amend the changelog. Versions can be pushed to PyPI
7194
using the command:

0 commit comments

Comments
 (0)