From aa9941f5274da2b4e8c5713e54aa30f53f72ee8d Mon Sep 17 00:00:00 2001 From: Leonardo Di Donato Date: Tue, 11 Jun 2019 15:12:22 -0700 Subject: [PATCH 1/2] docs: explaining issue triaging Signed-off-by: Leonardo Di Donato --- CONTRIBUTING.md | 43 ++++++++++++++++++++++++++++++------------- 1 file changed, 30 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f36667c420..9a1941b132a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,11 @@ # Contributing to Falco -* [Code of Conduct](#code-of-conduct) -* [Issues](#issues) -* [Pull Requests](#pull-requests) -* [Developer Certificate Of Origin](#developer-certificate-of-origin) +- [Contributing to Falco](#contributing-to-falco) + - [Code of Conduct](#code-of-conduct) + - [Issues](#issues) + - [Triage issues](#triage-issues) + - [Pull Requests](#pull-requests) + - [Developer Certificate Of Origin](#developer-certificate-of-origin) ## Code of Conduct @@ -11,12 +13,11 @@ Falco has a [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. - ## 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. - Enhancement: any kind of new feature need to be discussed in this kind of issue, do you want a new rule or a new feature? This is the kind of issue you want to open. Be very good at explaining your intent, it's always important that others can understand what you mean in order to discuss, be open and collaborative in letting others help you getting this done! - Failing tests: you noticed a flaky test or a problem with a build? This is the kind of issue to triage that! @@ -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! - 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 @@ -36,22 +53,22 @@ Thanks for taking time to make a [pull request](https://help.github.com/articles In the PR body, feel free to add an area label if appropriate by typing `/area `, PRs will also need a kind, make sure to specify the appropriate one by typing `/kind `. -The list of labels is [here](https://github.com/falcosecurity/falco/labels). +The list of labels is [here](https://github.com/falcosecurity/falco/labels). Also feel free to suggest a reviewer with `/assign @theirname`. -Once your reviewer is happy, they will say `/lgtm` which will apply the -`lgtm` label, and will apply the `approved` label if they are an +Once your reviewer is happy, they will say `/lgtm` which will apply the +`lgtm` label, and will apply the `approved` label if they are an [owner](/OWNERS). -Your PR will be automatically merged once it has the `lgtm` and `approved` +Your PR will be automatically merged once it has the `lgtm` and `approved` labels, does not have any `do-not-merge/*` labels, and all status checks (eg., rebase, tests, DCO) are positive. ## Developer Certificate Of Origin -The [Developer Certificate of Origin (DCO)](https://developercertificate.org/) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. +The [Developer Certificate of Origin (DCO)](https://developercertificate.org/) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Contributors to the Falco project sign-off that they adhere to these requirements by adding a `Signed-off-by` line to commit messages. From 106f861be04a02a57dfc59548c4110651aae78ab Mon Sep 17 00:00:00 2001 From: Leonardo Di Donato Date: Tue, 11 Jun 2019 15:32:07 -0700 Subject: [PATCH 2/2] docs: more on labels Signed-off-by: Leonardo Di Donato --- CONTRIBUTING.md | 48 +++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 41 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9a1941b132a..033799909de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,8 @@ - [Code of Conduct](#code-of-conduct) - [Issues](#issues) - [Triage issues](#triage-issues) + - [More about labels](#more-about-labels) + - [Slack](#slack) - [Pull Requests](#pull-requests) - [Developer Certificate Of Origin](#developer-certificate-of-origin) @@ -26,11 +28,11 @@ The best way to get **involved** in the project is through issues, you can help - Issues triaging: participating in the discussion and adding details to open issues is always a good thing, 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. ### Triage issues -We need help in categorizing issues. Thus any help is welcomed! +We need help in categorizing issues. Thus any help is welcome! When you triage an issue, you: @@ -38,13 +40,43 @@ When you triage an issue, you: * quickly close it by correctly answering a question -* point the reporter to a resource answering the issue +* point the reporter to a resource or documentation answering the issue * tag it via labels, projects, or milestones -* take ownership submitting a PR for it, at your discretion +* take ownership submitting a PR for it, in case you want 😇 -Any other discussion, and **support requests** should go through the `#falco` channel in the Sysdig slack, join [here](https://slack.sysdig.com). +#### More about labels + +These guidelines are not set in stone and are subject to change. + +Anyway a `kind/*` label for any issue is mandatory. + +This is the current [label set](https://github.com/falcosecurity/falco/labels) we have. + +You can use commands - eg., `/label ` to add (or remove) labels or manually do it. + +The commands available are the following ones: + +``` +/[remove-](area|kind|priority|triage|label) +``` + +Some examples: + +* `/area rules` +* `/remove-area rules` +* `/kind kernel-module` +* `/label good-first-issue` +* `/triage duplicate` +* `/triage unresolved` +* `/triage not-reproducible` +* `/triage support` +* ... + +### Slack + +Other discussion, and **support requests** should go through the `#falco` channel in the Sysdig slack, please join [here](https://slack.sysdig.com). ## Pull Requests @@ -61,21 +93,23 @@ Once your reviewer is happy, they will say `/lgtm` which will apply the `lgtm` label, and will apply the `approved` label if they are an [owner](/OWNERS). - Your PR will be automatically merged once it has the `lgtm` and `approved` labels, does not have any `do-not-merge/*` labels, and all status checks (eg., rebase, tests, DCO) are positive. - ## Developer Certificate Of Origin The [Developer Certificate of Origin (DCO)](https://developercertificate.org/) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Contributors to the Falco project sign-off that they adhere to these requirements by adding a `Signed-off-by` line to commit messages. +``` This is my commit message Signed-off-by: John Poiana +``` Git even has a `-s` command line option to append this automatically to your commit message: +``` $ git commit -s -m 'This is my commit message' +```