Update contributing guidelines #2018
Conversation
.github/pull_request_template.md
Outdated
|
|
||
| <!-- Point reviewers to the test, code example or documentation which shows usage example of this feature --> | ||
| 1. **Code is formatted**: Have you run your code through clang-format to ensure it adheres to the project's coding standards? | ||
| <!-- Yes/No --> |
There was a problem hiding this comment.
If you want the PR opener to leave Yes or No under each point, then I suggest substituting the template with the easier one for editing:
| <!-- Yes/No --> | |
| Yes No |
Now the inapplicable option is getting removed with just double click + backspace.
There was a problem hiding this comment.
I hope it is not desired to actually type or leave Yes letters under each question. In case of Yes the reviewer just leaves anything untouched.
Thus, I suggest in case of any No (if so) add an instruction to explicitly type the corresponding No with the mandatory reasoning.
There was a problem hiding this comment.
May use YAML forms like libp2p/cpp-libp2p#230?
There was a problem hiding this comment.
@turuslan I introduced these forms for issues, but unfortunately they are not available for PRs yet
|
|
||
| ## 8. Contact info | ||
|
|
||
| Quadrivium Numera Pte. Ltd. can be reached at github[at]qdrvm.io |
There was a problem hiding this comment.
github[at]qdrvm.io
May be it is already done. If not, then I suggest to set up a redirect for all incoming mail from this address to someone's primary email, otherwise there is a chance of missing something or not being on time.
There was a problem hiding this comment.
yes, we do redirect messages from this email to the employees email
Referenced issues
None
Description of the Change
Improve contributing guidelines to emphasize importance of proper documentation and ensure having good quality PRs
Benefits
Clear policy about contributing to KAGOME
Possible Drawbacks
Stricter requirements for docs