Add pull request template and improve CONTRIBUTING guide #1976
Conversation
|
|
||
| Adding this information in the commit message also ensures that this information will still be available if the package would be hosted via another code hosting platform in the future. | ||
|
|
||
| A good commit message for a commit to PHPCompatibility would typically look something like this: |
There was a problem hiding this comment.
This is very useful, thanks!
| Each sniff has its own remit and should function independently of other sniffs. | ||
|
|
||
| With that in mind, sniffs are, and should be, tested in isolation. | ||
| The tests for each sniff should only test the functionality of that specific sniff, independently of that the code used to test the sniff may also trigger errors from other sniffs. |
There was a problem hiding this comment.
I understand the essence of the second part of this sentence, but I'm having trouble parsing it.
|
Thanks for the review @afilina ! I've made some further changes and I believe (hope) I've addressed all your remarks now. @wimg Please SQUASH-merge (if I don't squash the commits myself before you get to the PR). |
| A good commit message for a commit to PHPCompatibility would typically look something like this: | ||
| ``` | ||
| PHP #.# | SniffName: detect something specific |
There was a problem hiding this comment.
Just a question: given that sniff names are very long, does PHPCompatibility prescribe a char limit on commit subject lines (typically 72)?
There was a problem hiding this comment.
No, we don't have a character limit on commit subject lines. Rule of thumb: keep the title as short as possible while still conveying what the commit is about.
708954e to
c0013d8
Compare
Based on various things afilina and me discussed in a video call while reviewing one of the new sniffs she pulled. There are quite some conventions which were not explicit in the CONTRIBUTING guide. Along the same lines, there are a number of "best practices"/"pro-tips" which can be helpful for people new to contributing to this codebase. No doubt we'll come across more things to be documented along the way, but this is a first step towards improving the contributor experience. Co-authored-by: Anna Filina <afilina@gmail.com>
c0013d8 to
d224a94
Compare
|
Rebased without changes to get a passing build now #1995 has been merged. |
Based on various things @afilina and me discussed in a video call while reviewing one of the new sniffs she pulled.
There are quite some conventions which were not explicit in the CONTRIBUTING guide. Along the same lines, there are a number of "best practices"/"pro-tips" which can be helpful for people new to contributing to this codebase.
No doubt we'll come across more things to be documented along the way, but this is a first step towards improving the contributor experience.