chore: add contributing guide

This commit is contained in:
Fernandez Ludovic 2024-05-23 18:32:12 +02:00
parent 182ce0be58
commit 4655d13902
2 changed files with 42 additions and 2 deletions

25
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,25 @@
## How to contribute
### Did you find a bug?
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/golangci/golangci-lint-action/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/golangci/golangci-lint-action/issues/new).
Be sure to include a **title and clear description**, as much relevant information as possible,
and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
* **Do not open up a GitHub issue if the bug is a security vulnerability**,
and instead to refer to our [security policy](https://github.com/golangci/golangci-lint-action?tab=security-ov-file).
### Do you intend to add a new feature or change an existing one?
* Suggest your change inside an [issue](https://github.com/golangci/golangci-lint-action/issues).
* Do not open a pull request on GitHub until you have collected positive feedback about the change.
### Did you write a patch that fixes a bug?
* Open a new GitHub pull request with the patch.
* Ensure the PR description clearly describes the problem and solution.
Include the relevant issue number if applicable.

View File

@ -36,14 +36,29 @@ body:
required: true required: true
- type: textarea - type: textarea
id: config id: workflow-file
attributes: attributes:
label: Workflow file label: Workflow file
value: |- value: |-
<details> <details>
```yml
<add your file content here>
``` ```
<add you file here>
</details>
validations:
required: true
- type: textarea
id: config
attributes:
label: Golangci-lint configuration
value: |-
<details>
```yml
<add your file content here>
``` ```
</details> </details>