Skip to content

Commit 05e056b

Browse files
committed
emphasize the policy for actionlint's features at the top of the contribution guide
1 parent 28eb1ab commit 05e056b

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

CONTRIBUTING.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
# Policy for actionlint's features
2+
3+
- actionlint focuses on detecting mistakes. Feature requests and patches for checks related to code style or
4+
conventions are generally not accepted.
5+
- actionlint tries to keep [the configuration](docs/config.md) as minimal as possible. Feature requests and patches
6+
for checks that require user configurations are generally not accepted.
7+
8+
These are important to keep actionlint useful and convenient for everyone. I believe that no one wants to create and
9+
maintain a heavy configuration file just for linting CI workflows.
10+
11+
It's helpful to check if a similar patch has been rejected in the past before submitting it.
12+
113
# Reporting an issue
214

315
To report a bug, please submit a new ticket on GitHub. It's helpful to search similar tickets before making it.
@@ -11,8 +23,6 @@ investigate.
1123
# Sending a patch
1224

1325
Thank you for taking your time to improve this project. To send a patch, please submit a new pull request on GitHub.
14-
It's helpful to check if a similar patch was rejected in the past before making it. actionlint focuses on detecting
15-
mistakes so adding rules related to styles or conventions is basically not accepted.
1626

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

0 commit comments

Comments
 (0)