Add scripts to automated release process and validate commit messages #373
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1) Add script to validate commit messages. Make it execute (using the `commit-msg` hook) before the commit is allowed to go through, thus, allowing to reject the commit if its message dosn't respect the conventions. 2) Add script to provide (using `prepare-commit-msg` hook) additional information on the expected form of the commit message, in the commit message - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - See also: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks#_committing_workflow_hooks Ref #345
alrra
requested review from
a team and
qzhou1607-zz
and removed request for
a team
molant
requested changes
Jul 10, 2017
| # Pull Requests | ||
|
|
||
| Contributing code to `sonar` is done using pull requests, This is | ||
| the fastest way for us to evaluate your code and to merge it into |
There was a problem hiding this comment.
My intent was to have . instead of ,.
| <!-- markdownlint-enable MD033 --> | ||
|
|
||
| Before you send the pull request, be sure to rebase onto the [upstream | ||
| source](../development-environment), . This ensures your code is running |
There was a problem hiding this comment.
There is a comma and a dot together.
| This is a step-by-step guide to setting up a local development | ||
| environment that will let you contribute back to the project. | ||
|
|
||
| ## Step 1: Install Node.js |
There was a problem hiding this comment.
The pull request doc has anchors in the titles. Do we want them here too?
There was a problem hiding this comment.
Didn't add them because the list was kinda small, but let's do it.
| ## Step 1: Install Node.js | ||
|
|
||
| Go to [`nodejs.org`](https://nodejs.org/en/download/) to download | ||
| and install the latest stable version of `Node.js` for your operating |
There was a problem hiding this comment.
Node 8.0 is not yet LTS. Maybe we should make a mention to it?
There was a problem hiding this comment.
Changed the link to: https://nodejs.org/en/download/current/.
|
@molant I've addressed all your feedback. |
molant
approved these changes
Jul 10, 2017
|
Proof of working on smartgit as well!
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I know this is a bigger PR, but the commits in it are related (and kinda depend) no each other.
Changes (see commit messages for more details):
Added script to automate release process.
Added script to validate commit message.
when the user goes
git commit, she/we will see something like:if the commit message doesn't respect the structure we imposed, the commit will fail and the user will see the list of problems:
e.g. for
Added pull request related guidelines