From 3b594a5263eb80db8992a0d44f8133b16deb73d5 Mon Sep 17 00:00:00 2001 From: rhysd Date: Fri, 9 Feb 2024 23:48:55 +0900 Subject: [PATCH] describe how to report bugs and send patches in CONTRIBUTING.md --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62ef1c557..2c3438562 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,22 @@ +# Reporting an issue + +To report a bug, please submit a new ticket on GitHub. It's helpful to search similar tickets before making it. + +https://github.com/rhysd/actionlint/issues/new + +Providing a reproducible workflow content is much appreciated. If only a small snippet of workflow is provided or no +input is provided at all, such issue tickets may get lower priority since they are occasionally time consuming to +investigate. + +# Sending a patch + +Thank you for taking your time to improve this project. To send a patch, please submit a new pull request on GitHub. +It's helpful to check if a similar patch was rejected in the past before making it. + +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. + # Development `make` (3.81 or later) is useful to run each tasks and reduce redundant builds/tests.