You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,14 @@ You can also self-assign an existing issue by commmenting #self-assign on the is
40
40
5.[Open a pull-request](https://github.com/ServiceNow/azimuth/compare) with your branch.
41
41
6. Once a team member approves your changes, we will merge the pull request promptly.
42
42
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.
0 commit comments