Skip to content

Commit ab1bcd8

Browse files
Update contribution guidelines (#220)
* update contribution guidelines * Apply suggestions from code review Co-authored-by: Lindsay Brin <[email protected]> * Apply suggestions from code review Co-authored-by: Lindsay Brin <[email protected]>
1 parent b8797bb commit ab1bcd8

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,14 @@ You can also self-assign an existing issue by commmenting #self-assign on the is
4040
5. [Open a pull-request](https://github.com/ServiceNow/azimuth/compare) with your branch.
4141
6. Once a team member approves your changes, we will merge the pull request promptly.
4242

43+
### Guidelines for a good pull-request
44+
When coding, pay special attention to the following:
45+
* Your code should be well commented for non-trivial sections, so it can be easily understood and maintained by others.
46+
* Do not expose any personal/sensitive data.
47+
* Add unit tests when a notable functionality has been added or changed.
48+
* Read our [development best practices](https://servicenow.github.io/azimuth/development/dev-practices/) to set up `pre-commit`, and test your changes.
49+
* Do not forget to notify the team in advance that you are working on an issue (Using #self-assign or by creating an issue). Mention it if you need to add/bump a dependency.
50+
* Check the [PR template](https://github.com/ServiceNow/azimuth/blob/main/.github/pull_request_template.md) in advance to see the checklist of things to do.
4351

4452
### Where to ask for help!
4553

0 commit comments

Comments
 (0)