Skip to content

Add commit message guidelines #689

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,30 @@ If you do make any changes to models (modification or addition), make sure to
run ``python manage.py makemigrations`` to enable the server to migrate existing
data to the new models.

Commit Guidelines
-----------------

It is advised to care of the following while committing any change:

1. Separate subject from body with a blank line
2. Limit the subject line to 50 characters
3. Capitalize the subject line
4. Do not end the subject line with a period
5. Use the imperative mood in the subject line
6. Wrap the body at 72 characters
7. Use the body to explain what and why vs. how

Do note that the above are meant to be guidelines and not lines set in stone.

Source and Credits: `How to Write a Git Commit Message`_ by Chris Beam.

Code Convention
---------------

We follow the `Black Coding Style`_, and sort our imports with `isort`_. This
code style is enforced with automation.

.. _`issue tracker`: https://github.com/pythonindia/junction/issues
.. _`How to Write a Git Commit Message`: https://chris.beams.io/posts/git-commit/
.. _`isort`: https://isort.readthedocs.org/en/latest/
.. _`Black Coding Style`: https://black.readthedocs.io/en/latest/the_black_code_style.html
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Contributing

[issue-list]: https://github.com/pythonindia/junction/issues/
[new-issue]: https://github.com/pythonindia/junction/issues/new
[guidelines]: https://github.com/pythonindia/junction/blob/master/.github/CONTRIBUTING.md
[guidelines]: https://github.com/pythonindia/junction/blob/master/.github/CONTRIBUTING.rst
[getting-started]: https://in-junction.readthedocs.io/en/latest/development/getting-started.html

License
Expand Down