Skip to content

Commit 8036697

Browse files
authored
Add LICENSE and better README (crytic#48)
1 parent f0dcb6c commit 8036697

File tree

4 files changed

+754
-171
lines changed

4 files changed

+754
-171
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ To better understand how to make responsible open source contributions, consider
1313
### Overview
1414
When introducing changes to the project, note the following requirements:
1515
- 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:
1919
- Every type, function, const, and other variables should be accompanied by [doc comments](https://tip.golang.org/doc/comment).
2020
- 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.
2121
- Inline comments should specify any non-trivial caveats with a given piece of code, considerations to make when maintaining it, etc.
2222
- Any considerations regarding potential weaknesses or future improvements to be made within your code should be accompanied by an inline comment prefixed with `// TODO: `
2323
- 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**.
2626

2727
If any of these requirements are violated, you should expect your pull request to be denied merging until appropriately remediated.
2828

@@ -40,4 +40,4 @@ Pull request reviewers have a responsibility to uphold these standards. Even if
4040
- Ensure JSON keys are `camelCase` rather than `snake_case`, where possible.
4141

4242
## License
43-
TODO
43+
The license for this software can be found [here](./LICENSE).

0 commit comments

Comments
 (0)