Skip to content

Commit 8f68a02

Browse files
committed
Merge with master branch
2 parents 552c25b + 466959a commit 8f68a02

File tree

5 files changed

+370
-196
lines changed

5 files changed

+370
-196
lines changed

.github/workflows/safer-golangci-lint.yml

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,12 @@
2828
# 1. GOLINTERS_VERSION
2929
# 2. GOLINTERS_TGZ_DGST
3030
#
31-
# Release v1.42.1 (September 29, 2021)
32-
# - Bump golangci-lint to 1.42.1.
33-
# - sha256(linux-amd64.tar.gz) is 214b093c15863430c4b66dd39df677dab6e38fc873ded147e331740d50eea51f
34-
# - sha384(linux-amd64.tar.gz) is 80e7e4afb5a58985fdd2ee7c099086541bc41a46b59dac1ae04f73c25abeafe30e5cd91dd1a57dc754efaad779c849cb
31+
# Release v1.43.0 (Dec 5, 2021)
32+
# - Bump Go to 1.17.x.
33+
# - Bump golangci-lint to 1.43.0.
34+
# - Checksum for golangci-lint-1.43.0-linux-amd64.tar.gz
35+
# - SHA-256 is f3515cebec926257da703ba0a2b169e4a322c11dc31a8b4656b50a43e48877f4
36+
# - SHA-384 is 0a5e9adc3cc93fbc2e3c8f4daee061e77407fe3e702001021ef03c8bdf39a81c36c42d35e8ba970f4f09db2279c881bf
3537
#
3638
name: linters
3739

@@ -42,9 +44,9 @@ on:
4244
branches: [main, master]
4345

4446
env:
45-
GOLINTERS_VERSION: 1.42.1
47+
GOLINTERS_VERSION: 1.43.0
4648
GOLINTERS_ARCH: linux-amd64
47-
GOLINTERS_TGZ_DGST: 80e7e4afb5a58985fdd2ee7c099086541bc41a46b59dac1ae04f73c25abeafe30e5cd91dd1a57dc754efaad779c849cb
49+
GOLINTERS_TGZ_DGST: 0a5e9adc3cc93fbc2e3c8f4daee061e77407fe3e702001021ef03c8bdf39a81c36c42d35e8ba970f4f09db2279c881bf
4850
GOLINTERS_TIMEOUT: 5m
4951
OPENSSL_DGST_CMD: openssl dgst -sha384 -r
5052
CURL_CMD: curl --proto =https --tlsv1.2 --location --silent --show-error --fail
@@ -62,7 +64,7 @@ jobs:
6264
- name: Setup Go
6365
uses: actions/setup-go@v2
6466
with:
65-
go-version: 1.16.x
67+
go-version: 1.17.x
6668

6769
- name: Install golangci-lint
6870
run: |

CONTRIBUTING.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,58 @@
11
# How to contribute
22

3-
This project started because I needed an easy, small, and crash-proof CBOR library for my [WebAuthn (FIDO2) server library](https://github.com/fxamacker/webauthn). I believe this was the first and still only standalone CBOR library (in Go) that is fuzz tested as of November 10, 2019.
3+
Here are some ways you can contribute:
44

5-
To my surprise, Stefan Tatschner (rumpelsepp) submitted the first 2 issues when I didn't expect this project to be noticed. So I decided to make it more full-featured for others by announcing releases and asking for feedback. Even this document exists because Montgomery Edwards⁴⁴⁸ (x448) opened [issue #22](https://github.com/fxamacker/cbor/issues/22). In other words, you can contribute by opening an issue that helps the project improve. Especially in the early stages.
6-
7-
When I announced v1.2 on Go Forum, Jakob Borg (calmh) responded with a thumbs up and encouragement. Another project of equal priority needed my time and Jakob's kind words tipped the scale for me to work on this one (speedups for [milestone v1.3](https://github.com/fxamacker/cbor/issues?q=is%3Aopen+is%3Aissue+milestone%3Av1.3.0).) So words of appreciation or encouragement is nice way to contribute to open source projects.
8-
9-
Another way is by using this library in your project. It can lead to features that benefit both projects, which is what happened when oasislabs/oasis-core switched to this CBOR libary -- thanks Yawning Angel (yawning) for requesting BinaryMarshaler/BinaryUnmarshaler and Jernej Kos (kostco) for requesting RawMessage!
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.
1011

1112
If you'd like to contribute code or send CBOR data, please read on (it can save you time!)
1213

1314
## Private reports
15+
1416
Usually, all issues are tracked publicly on [GitHub](https://github.com/fxamacker/cbor/issues).
1517

1618
To report security vulnerabilities, please email [email protected] 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).
1719

1820
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.
1921

20-
## Prerequisites to pull requests
22+
## Pull requests
23+
24+
Pull requests have signing requirements and must not be anonymous. Exceptions can be made for docs and CI scripts.
25+
26+
See our [Pull Request Template](https://github.com/fxamacker/cbor/blob/master/.github/pull_request_template.md) for details.
27+
2128
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.
2229

2330
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.
2431

2532
## Describe your issue
33+
2634
Clearly describe the issue:
2735
* If it's a bug, please provide: **version of this library** and **Go** (`go version`), **unmodified error message**, and describe **how to reproduce it**. Also state **what you expected to happen** instead of the error.
2836
* If you propose a change or addition, try to give an example how the improved code could look like or how to use it.
2937
* If you found a compilation error, please confirm you're using a supported version of Go. If you are, then provide the output of `go version` first, followed by the complete error message.
3038

3139
## Please don't
40+
3241
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.
3342

3443
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.
3544

3645
## Wanted
46+
3747
* Opening issues that are helpful to the project
3848
* Using this library in your project and letting me know
3949
* Sending well-formed CBOR data (<= 512 bytes) that causes crashes (none found yet).
4050
* Sending malformed CBOR data (<= 512 bytes) that causes crashes (none found yet, but bad actors are better than me at breaking things).
41-
* Sending tests or data for unit tests that increase code coverage (currently at 97.8% for v1.2.)
51+
* Sending tests or data for unit tests that increase code coverage (currently around 98%)
4252
* Pull requests with small changes that are well-documented and easily understandable.
43-
* Sponsors, donations, bounties, subscriptions: I'd like to run uninterrupted fuzzing between releases on a server with dedicated CPUs (after v1.3 or v1.4.)
53+
* Sponsors, donations, bounties, or subscriptions.
4454

4555
## Credits
46-
This guide used nlohmann/json contribution guidelines for inspiration as suggested in issue #22.
4756

57+
- This guide used nlohmann/json contribution guidelines for inspiration as suggested in issue #22.
58+
- Special thanks to @lukseven for pointing out the contribution guidelines didn't mention signing requirements.

0 commit comments

Comments
 (0)