Skip to content

Commit 9cab20e

Browse files
authored
Update CONTRIBUTING.md (#423)
Cleanup for v2.5.0.
1 parent 5792a94 commit 9cab20e

1 file changed

Lines changed: 11 additions & 28 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,26 @@
11
# How to contribute
22

3-
Here are some ways you can contribute:
3+
You can contribute by using the library, opening issues, or opening pull requests.
44

5-
- Give this library a star on GitHub. It doesn't cost anything and it lets maintainers know you appreciate their work.
6-
- Use this library in your project. By using this library, you're more likely to open an issue with feature request, etc.
7-
- Report security vulnerabilities privately by email after reading this contributing guide and [Security Policy](https://github.com/fxamacker/cbor#security-policy).
8-
- Open an issue with a feature request. It can help prioritize issues if you provide a link to your project and mention if a missing feature prevents your project from using this library.
9-
- Open an issue with a bug report. It's helpful if the bug report includes a link to a reproducer at [Go Playground](https://go.dev/play/).
10-
- Open a PR that would close a specific issue. Ask if it's a good time to open a PR in the issue because a solution might already be in progress. Please also read about the signing requirements before spending time on a PR.
5+
## Bug reports and security vulnerabilities
116

12-
If you'd like to contribute code or send CBOR data, please read on (it can save you time!)
13-
14-
## Private reports
15-
16-
Usually, all issues are tracked publicly on [GitHub](https://github.com/fxamacker/cbor/issues).
7+
Most issues are tracked publicly on [GitHub](https://github.com/fxamacker/cbor/issues).
178

189
To report security vulnerabilities, please email faye.github@gmail.com and allow time for the problem to be resolved before disclosing it to the public. For more info, see [Security Policy](https://github.com/fxamacker/cbor#security-policy).
1910

20-
Please do not send data that might contain personally identifiable information, even if you think you have permission. That type of support requires payment and a contract where I'm indemnified, held harmless, and defended for any data you send to me.
11+
Please do not send data that might contain personally identifiable information, even if you think you have permission. That type of support requires payment and a signed contract where I'm indemnified, held harmless, and defended by you for any data you send to me.
2112

2213
## Pull requests
2314

24-
Pull requests have signing requirements and must not be anonymous. Exceptions can be made for docs and CI scripts.
15+
Please [create an issue](https://github.com/fxamacker/cbor/issues/new/choose) before you begin work on a PR. The improvement may have already been considered, etc.
2516

26-
See our [Pull Request Template](https://github.com/fxamacker/cbor/blob/master/.github/pull_request_template.md) for details.
17+
Pull requests have signing requirements and must not be anonymous. Exceptions are usually made for docs and CI scripts.
2718

28-
Please [create an issue](https://github.com/fxamacker/cbor/issues/new/choose), if one doesn't already exist, and describe your concern. You'll need a [GitHub account](https://github.com/signup/free) to do this.
19+
See the [Pull Request Template](https://github.com/fxamacker/cbor/blob/master/.github/pull_request_template.md) for details.
2920

30-
If you submit a pull request without creating an issue and getting a response, you risk having your work unused because the bugfix or feature was already done by others and being reviewed before reaching Github.
21+
Pull requests have a greater chance of being approved if:
22+
- it does not reduce speed, increase memory use, reduce security, etc. for people not using the new option or feature.
23+
- it has > 97% code coverage.
3124

3225
## Describe your issue
3326

@@ -40,17 +33,7 @@ Clearly describe the issue:
4033

4134
Please don't send data containing personally identifiable information, even if you think you have permission. That type of support requires payment and a contract where I'm indemnified, held harmless, and defended for any data you send to me.
4235

43-
Please don't send CBOR data larger than 512 bytes. If you want to send crash-producing CBOR data > 512 bytes, please get my permission before sending it to me.
44-
45-
## Wanted
46-
47-
* Opening issues that are helpful to the project
48-
* Using this library in your project and letting me know
49-
* Sending well-formed CBOR data (<= 512 bytes) that causes crashes (none found yet).
50-
* Sending malformed CBOR data (<= 512 bytes) that causes crashes (none found yet, but bad actors are better than me at breaking things).
51-
* Sending tests or data for unit tests that increase code coverage (currently around 98%)
52-
* Pull requests with small changes that are well-documented and easily understandable.
53-
* Sponsors, donations, bounties, or subscriptions.
36+
Please don't send CBOR data larger than 1024 bytes by email. If you want to send crash-producing CBOR data > 1024 bytes by email, please get my permission before sending it to me.
5437

5538
## Credits
5639

0 commit comments

Comments
 (0)