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
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -13,16 +13,16 @@ To better understand how to make responsible open source contributions, consider
13
13
### Overview
14
14
When introducing changes to the project, note the following requirements:
15
15
- All changes to the main branch should be introduced via pull requests.
16
-
- Every pull request **MUST** be reviewed by at least one other peer prior to being merged into the main branch.
17
-
- Code **MUST** be supported on Linux, macOS, and Windows.
18
-
- Code **MUST** be sufficiently commented:
16
+
- Every pull request **must** be reviewed by at least one other peer prior to being merged into the main branch.
17
+
- Code **must** be supported on Linux, macOS, and Windows.
18
+
- Code **must** be sufficiently commented:
19
19
- Every type, function, const, and other variables should be accompanied by [doc comments](https://tip.golang.org/doc/comment).
20
20
- Inline comments should be provided for every block of code. These should explain what the block of code is aiming to achieve in plain english.
21
21
- Inline comments should specify any non-trivial caveats with a given piece of code, considerations to make when maintaining it, etc.
22
22
- Any considerations regarding potential weaknesses or future improvements to be made within your code should be accompanied by an inline comment prefixed with `// TODO: `
23
23
- Comments should provide some value to a new contributor and improve code readability.
24
-
- Your changes **MUST NOT** contain copyrighted or licensed works without ensuring copyright law or licenses have not been violated.
25
-
-**Code MUST be compliant with the considerations laid out in the subsections below**.
24
+
- Your changes **must not** contain copyrighted or licensed works without ensuring copyright law or licenses have not been violated.
25
+
-**Code must be compliant with the considerations laid out in the subsections below**.
26
26
27
27
If any of these requirements are violated, you should expect your pull request to be denied merging until appropriately remediated.
28
28
@@ -40,4 +40,4 @@ Pull request reviewers have a responsibility to uphold these standards. Even if
40
40
- Ensure JSON keys are `camelCase` rather than `snake_case`, where possible.
41
41
42
42
## License
43
-
TODO
43
+
The license for this software can be found [here](./LICENSE).
0 commit comments