Restrict the usage of issue references#25
Conversation
PauliusMacernis
left a comment
PauliusMacernis
left a comment
There was a problem hiding this comment.
Specify "References" part in "References should not appear in pull request title or any of its commits."
The rest looks ok to me.
|
|
||
| Create a pull request to `master` branch. The changes will be merged after they pass code review. | ||
|
|
||
| If an issue should be closed once a pull request is merged, it can be done automatically using Github issue references. Add "Closes #{issue number}" to description ([example](https://github.com/digitronas/akeneo-coding-standard/pull/5)). References should not appear in pull request title or any of its commits. |
There was a problem hiding this comment.
It would be good to point out to the specific version of the reference under the following:
References should not appear in pull request title or any of its commits.
The #number is also a reference, more like these exists. Should we tolerate a reference of another type than closes? I see no harm for another type of references to be used in commits or description. Either way, none of the references should probably be used in the title, I may agree with this one. Feel free to decide on this topic if you have an argument to support your opinion.
2 participants
Mandates how we should use github's issue references like Closes #X.