If you do not have push rights on the repository, please open a pull request with your commits for review. We do not merge pull requests to avoid merge commits in git history. Once reviewed, commits are applied manually (keeping authors) on HEAD to keep a flat history.
We follow standard git commit guidelines:
https://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines
In a few words:
- 1st line summary max. 50 chars
- unless really obvious, a blank line and a detailled description wrap to 72 chars focused on what and why instead of how (how must be wisely explained in codes comments or in documentation)
- only one logical changeset per commit
- git diff --check error free
Indentation:
- Python: 4 spaces.
- JS/HTML: 2 spaces.
Python code must respect pep8 and must be compatible with Python 2.6.
Here are the steps to follow to publish a new release of Slurm-web:
- Add an entry in debian/changelog with complete changelog
- Bump documentation version in doc/conf.py
- Commit all these changes with commit message "New release X.Y.Z"
- Tag this commit with using git-buildpackage: gbp buildpackage --git-tag-only
- Push the commit to remote master branch on GitHub
- Push the tag to GitHub
- Close the milestone
- Publish freshly generated HTML documentation to GitHub gh-pages branch
- Enjoy!