Skip to content

Commit

Permalink
explain points before submitting a PR
Browse files Browse the repository at this point in the history
  • Loading branch information
rhysd committed Feb 10, 2024
1 parent 9ce8fbe commit f5b31c2
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ mistakes so adding rules related to styles or conventions is basically not accep

https://github.com/rhysd/actionlint/pulls

Before submitting it, please ensure the build/tests/lints passed. How to run them is described in the following sections.
Before submitting your PR, please ensure the following points:

- Confirm build/tests/lints passed. How to run them is described in the following sections.
- If you added a new feature, consider to add tests and explain it in [the usage document](docs/usage.md).
- If you added a new public API, consider to add tests and a doc comment for the API.

# Development

Expand Down

0 comments on commit f5b31c2

Please sign in to comment.