Skip to content

Commit

Permalink
Suggestion for the selfcheck and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
rickie committed Apr 13, 2023
1 parent a6c2227 commit 40bafeb
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ Some pointers:
checks][error-prone-criteria]. Most guidelines described there apply to this
project as well, except that this project _does_ focus quite heavy on style
enforcement. But that just makes the previous point doubly important.
- Make sure that there are no violations of the newly introduced checks in the
codebase itself by running the [self check][error-prone-support-self-check].
See the [development instructions][error-prone-support-developing] for extra
context.
- Make sure that a check's [(mutation) test
coverage][error-prone-support-mutation-tests] is or remains about as high as
it can be. Not only does this lead to better tests, it also points out
Expand All @@ -78,3 +82,4 @@ Some pointers:
[error-prone-support-issues]: https://github.com/PicnicSupermarket/error-prone-support/issues
[error-prone-support-mutation-tests]: https://github.com/PicnicSupermarket/error-prone-support/blob/master/run-mutation-tests.sh
[error-prone-support-pulls]: https://github.com/PicnicSupermarket/error-prone-support/pulls
[error-prone-support-self-check]: https://github.com/PicnicSupermarket/error-prone-support/blob/master/apply-error-prone-suggestions.sh
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ use the latest release where feasible.
## Reporting a vulnerability

To report a vulnerability, please visit the [security
advisories][security-advisories] page an click _Report a vulnerability_. We
advisories][security-advisories] page and click _Report a vulnerability_. We
will take such reports seriously and work with you to resolve the issue in a
timely manner.

[security-advisories]: https://github.com/PicnicSupermarket/error-prone-support/security/advisories
[semantic-versioning]: https://semver.org/
[semantic-versioning]: https://semver.org

0 comments on commit 40bafeb

Please sign in to comment.