docs: explaining issue triaging

Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
This commit is contained in:
Leonardo Di Donato 2019-06-11 15:12:22 -07:00 committed by poiana
parent 56324d094c
commit cf1484c14d

View File

@ -1,9 +1,11 @@
# Contributing to Falco # Contributing to Falco
* [Code of Conduct](#code-of-conduct) - [Contributing to Falco](#contributing-to-falco)
* [Issues](#issues) - [Code of Conduct](#code-of-conduct)
* [Pull Requests](#pull-requests) - [Issues](#issues)
* [Developer Certificate Of Origin](#developer-certificate-of-origin) - [Triage issues](#triage-issues)
- [Pull Requests](#pull-requests)
- [Developer Certificate Of Origin](#developer-certificate-of-origin)
## Code of Conduct ## Code of Conduct
@ -11,10 +13,9 @@ Falco has a
[Code of Conduct](CODE_OF_CONDUCT) [Code of Conduct](CODE_OF_CONDUCT)
to which all contributors must adhere, please read it before interacting with the repository or the community in any way. to which all contributors must adhere, please read it before interacting with the repository or the community in any way.
## Issues ## Issues
Issues are the heartbeat ❤️ of the Falco project, there are three kinds of issues you can open: Issues are the heartbeat ❤️ of the Falco project, there are mainly three kinds of issues you can open:
- Bug report: you believe you found a problem in Falco and you want to discuss and get it fixed, - Bug report: you believe you found a problem in Falco and you want to discuss and get it fixed,
creating an issue with the **bug report template** is the best way to do so. creating an issue with the **bug report template** is the best way to do so.
@ -27,7 +28,23 @@ The best way to get **involved** in the project is through issues, you can help
sometimes issues need to be verified, you could be the one writing a test case to fix a bug! sometimes issues need to be verified, you could be the one writing a test case to fix a bug!
- Helping to resolve the issue: You can help in getting it fixed in many ways, more often by opening a pull request. - Helping to resolve the issue: You can help in getting it fixed in many ways, more often by opening a pull request.
Any other discussion, and **support requests** should go through the `#falco` channel in the Sysdig slack, join [here](https://slack.sysdig.com/). ### Triage issues
We need help in categorizing issues. Thus any help is welcomed!
When you triage an issue, you:
* assess whether it has merit or not
* quickly close it by correctly answering a question
* point the reporter to a resource answering the issue
* tag it via labels, projects, or milestones
* take ownership submitting a PR for it, at your discretion
Any other discussion, and **support requests** should go through the `#falco` channel in the Sysdig slack, join [here](https://slack.sysdig.com).
## Pull Requests ## Pull Requests