-
Notifications
You must be signed in to change notification settings - Fork 154
Quick Guidelines for Contributing to RepoSense
This serves to guide the new developers who wish to make a pull request (PR) to RepoSense.
When your work is still in-progress, you may make a draft PR (refer to the guide here.
Ensure that the following items are checked before asking for a review:
RepoSense follows the following coding styles located here. Please ensure that the coding styles follow the link provided before requesting for a review.
Wherever possible, try to ensure that new features, behavioral changes and/or bug fixes are covered with test cases.
Ensure that any changes that will render any part of the documentations to be outdated (such as UI updates, feature or behavioral changes) are updated accordingly.
Note that PRs will be squashed before merging into the master branch. While it is not necessary to follow the guidelines on commit messages for individual commits, please ensure that the guidelines on commit message title and body are followed when making a PR.
Ensure that the PR title follow the following convention.
-
Format: [
PR Number]Area affected:Summary of change -
Example:
[#750] Zoom Tab: display commit message body
The body of the commit message should be written in the comment section, and should adhere to the following format.
Format:
{current situation} -- use present tense
{why it needs to change}
{what is being done about it} -- use imperative mood
{why it is done that way}
{any other relevant info}
Example:
In the zoom tab, only the commit message titles are listed.
The commit message title alone may be too abstract for users to
understand the rationale of large implementations.
Let's display the commit message body below each commit message title
so that users get more clarity to the purpose of each commits.
Also, each line in the commit message body should be limited to 72 characters.
Refer to the guide here for more information.