Misc updates #470
Misc updates #470
Conversation
| **Smaller is better.** Submit *one* pull request per bug fix or feature. Do not | ||
| refactor or reformat code that is unrelated to your change. It is better to | ||
| submit many small pull requests rather than a single large one. Smaller, well- | ||
| scoped pull requests are easier to review and more likely to be accepted promptly. |
There was a problem hiding this comment.
Smaller is better. Submit a separate pull request for each bug fix or feature.
Avoid refactoring or reformatting code that is not related to your change.
Multiple small pull requests are easier to review and more likely to be accepted quickly.
| **How complex is your change likely to be?** For larger, more complicated changes | ||
| start by opening an issue and discussing a strategy with the relevant people. This | ||
| helps avoid unnecessary work and ensures alignment with project goals. |
There was a problem hiding this comment.
Consider the complexity of your change For larger or more complex changes,
start by opening an issue and discussing your approach with the relevant people.
This helps avoid unnecessary work and ensures alignment with project goals.
| **Prioritise clarity over cleverness.** Code is read far more often than it is | ||
| written so aim for code that is easy to understand and maintain. If the logic | ||
| is not immediately obvious then include comments to explain your reasoning. |
There was a problem hiding this comment.
Prioritise clarity over cleverness. Code is read more often than it is
written, so make it easy to understand and maintain. If the logic is not
immediately obvious then include comments to explain your reasoning.
2 participants
Applying the changes from #447, and assimilating some of the wording from CONTRIBUTING.md.
I couldn't find the reference to preparing code reviews for the deadline - this may have been removed in the rest of the changes we've been doing.
The UMDP3 link from the documentation change was sometimes erroring in the build - I tried a reformat to see if that helps.