CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update github maintainer docs (#9311)

This commit is contained in:
Samantha Wang 2021-06-01 14:09:37 -07:00 committed by GitHub
parent ad6d25aebc
commit aa837476d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 58 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
docs/maintainers/LABELS.md
View File

@ -6,9 +6,9 @@ issue tracker.
## Categories ## Categories
New issues are usually labeled one of `feature request`, `bug`, or `question`. New issues are automatically labeled `feature request`, `bug`, or `support`.
If you are unsure what label to apply you can use the `need more info` label If you are unsure what problem the author is proposing, you can use the `need more info` label
and if there is another issue you can add the duplicate label and close the and if there is another issue you can add the `closed/duplicate` label and close the
new issue. new issue.
New pull requests are usually labeled one of `enhancement`, `bugfix` or `new New pull requests are usually labeled one of `enhancement`, `bugfix` or `new
@ -17,18 +17,56 @@ plugin`.
## Additional Labels ## Additional Labels
Apply any of the `area/*` labels that match. If an area doesn't exist, new Apply any of the `area/*` labels that match. If an area doesn't exist, new
ones can be added but it is not a goal to have an area for all issues. ones can be added but **it is not a goal to have an area for all issues.**
If the issue only applies to one platform, you can use a `platform/*` label. If the issue only applies to one platform, you can use a `platform/*` label.
These are only applied to single platform issues which are not on Linux. These are only applied to single platform issues which are not on Linux.
The `breaking change` label can be added to issues and pull requests that
would result in a breaking change.
Apply `performance` to issues and pull requests that address performance
issues.
For bugs you may want to add `panic`, `regression`, or `upstream` to provide For bugs you may want to add `panic`, `regression`, or `upstream` to provide
further detail. further detail.
Labels starting with `pm` or `vert` are not applied by maintainers. Summary of Labels:
| Label | Description | Purpose |
| --- | ----------- | ---|
| `area/*` | These labels each corresponding to a plugin or group of plugins that can be added to identify the affected plugin or group of plugins | categorization |
| `breaking change` | Improvement to Telegraf that requires breaking changes to the plugin or agent; for minor/major releases | triage |
| `bug` | New issue for an existing component of Telegraf | triage |
| `cloud` | Issues or request around cloud environments | categorization |
| `dependencies` | Pull requests that update a dependency file | triage |
| `discussion` | Issues open for discussion | community/categorization |
| `documentation` | Issues related to Telegraf documentation and configuration descriptions | categorization |
| `error handling` | Issues related to error handling | categorization |
| `external plugin` | Plugins that would be ideal external plugin and expedite being able to use plugin w/ Telegraf | categorization |
| `good first issue` | This is a smaller issue suited for getting started in Telegraf, Golang, and contributing to OSS | community |
| `help wanted` | Request for community participation, code, contribution | community |
| `need more info` | Issue triaged but outstanding questions remain | community |
| `performance` | Issues or PRs that address performance issues | categorization|
| `platform/*` | Issues that only apply to one platform | categorization |
| `plugin/*` | 1. Request for new * plugins 2. Issues/PRs that are related to * plugins | categorization |
| `ready for final review` | Pull request has been reviewed and/or tested by multiple users and is ready for a final review | triage |
| `rfc` | Request for comment - larger topics of discussion that are looking for feedback | community |
| `support` |Telegraf questions, may be directed to community site or slack | triage |
| `upstream` | Bug or issues that rely on dependency fixes and we cannot fix independently | triage |
| `waiting for response` | Waiting for response from contributor | community/triage |
| `wip` | PR still Work In Progress, not ready for detailed review | triage |
Labels starting with `pm` are not applied by maintainers.
## Closing Issues
We close issues for the following reasons:
| Label | Reason |
| --- | ----------- |
| `closed/as-designed` | Labels to be used when closing an issue or PR with short description why it was closed |
| `closed/duplicate` | This issue or pull request already exists |
| `closed/external-candidate` | The feature request is best implemented by an external plugin |
| `closed/external-issue` | The feature request is best implemented by an external plugin |
| `closed/needs more info` | Did not receive the information we need within 3 months from last activity on issue |
| `closed/not-reproducible` | Given the information we have we can't reproduce the issue |
| `closed/out-of-scope` | The feature request is out of scope for Telegraf - highly unlikely to be worked on |
| `closed/question` | This issue is a support question, directed to community site or slack |

16
docs/maintainers/PULL_REQUESTS.md
View File

@ -2,8 +2,8 @@
## Before Review ## Before Review
Ensure that the CLA is signed. The only exemption would be non-copyrightable Ensure that the CLA is signed (the `telegraf-tiger` bot performs this check). The
changes such as fixing a typo. only exemption would be non-copyrightable changes such as fixing a typo.
Check that all tests are passing. Due to intermittent errors in the CI tests Check that all tests are passing. Due to intermittent errors in the CI tests
it may be required to check the cause of test failures and restart failed it may be required to check the cause of test failures and restart failed
@ -35,13 +35,15 @@ This method is used because many pull requests do not have a clean change
history and this method allows us to normalize commit messages as well as history and this method allows us to normalize commit messages as well as
simplifies backporting. simplifies backporting.
### Rewriting the commit message
After selecting "Squash and Merge" you may need to rewrite the commit message. After selecting "Squash and Merge" you may need to rewrite the commit message.
Usually the body of the commit messages should be cleared as well, unless it Usually the body of the commit messages should be cleared as well, unless it
is well written and applies to the entire changeset. Use imperative present is well written and applies to the entire changeset.
tense for the first line of the message: instead of "I added tests for" or - Use imperative present tense for the first line of the message:
"Adding tests for," use "Add tests for.". The default merge commit messages - Use "Add tests for" (instead of "I added tests for" or "Adding tests for")
include the PR number at the end of the commit message, keep this in the final - The default merge commit messages include the PR number at the end of the
message. If applicable mention the plugin in the message. commit message, keep this in the final message.
- If applicable mention the plugin in the message.
**Example Enhancement:** **Example Enhancement:**