Skip to content

Improve issue referencing standards in contributing guidelines (#106) #239

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.

Sign up for GitHub

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
anish-devgit wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve issue referencing standards in contributing guidelines (#106) #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Contributing to AboutCode
#########################

We welcome you and your interest in contributing to open source software!
AboutCode is always looking for enthusiatic contributors and we are happy
AboutCode is always looking for enthusiastic contributors and we are happy
to help with any questions or comments. Here a few resources to get
started:

Expand Down
17 changes: 12 additions & 5 deletions docs/source/contributing/writing_good_commit_messages.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,13 @@ The main style points are these:

Subject:

- Add a issue number at the end of the line when available as in "#234"
- Add an issue reference at the end of the line when available. For commit
messages within the same repository, you can use the shorthand format like
"Fixes #234". However, for code comments or cross-repository references,
always use full GitHub URLs (e.g.,
"https://github.com/aboutcode-org/aboutcode/issues/234") to prevent broken
references if the code is moved to another repository. See
https://github.com/aboutcode-org/aboutcode/issues/106 for more context.
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
Expand All @@ -38,15 +44,16 @@ Body:

Other comments:

We like to suffix the subject line with an issue number. If this was a
trivial change it may not have one though. If it had one a you would use
``#156`` as a suffix to the first line.
We like to suffix the subject line with an issue reference. If this was a
trivial change it may not have one though. For commits within this repository,
you can use the shorthand ``#156`` as a suffix to the first line. For code
comments that might be moved to other repositories, use full URLs.

We like to tell why the commit is there and use an imperative style, like
if you were giving an order to the codebase with your commit:

e.g rather than : ``Minor fix for unnecessary operations.`` may be ``Remove
unnecessary operations #123`` or::
unnecessary operations https://github.com/aboutcode-org/aboutcode/issues/123`` or::

Remove unnecessary operations #123

Expand Down