go-ethereum/content/docs/developers/geth-developer/issue-handling-workflow.md

61 lines
2.4 KiB
Markdown
Raw Normal View History

2022-07-27 07:38:03 -05:00
---
title: Issue Handling Workflow
description: Instructions for managing Github issues
2022-07-27 07:38:03 -05:00
---
### Draft proposal
2022-07-27 07:38:03 -05:00
* Keep the number of open issues under 820
2022-07-27 07:38:03 -05:00
* Keep the ratio of open issues per all issues under 13%
2022-07-27 07:38:03 -05:00
* Have 50 issues labelled [help wanted](https://github.com/ethereum/go-ethereum/labels/help%20wanted) and 50 [good first issue](https://github.com/ethereum/go-ethereum/labels/good%20first%20issue).
2022-07-27 07:38:03 -05:00
* Use structured labels of the form `<category>:<label>` or if need be `<category>:<main>/<sub>`, for example `area: plugins/foobuzzer`.
2022-07-27 07:38:03 -05:00
* Use the following labels. Areas and statuses depend on the application and workflow.
2022-07-27 07:38:03 -05:00
- area
- `area: android`
- `area: clef`
- `area: network`
- `area: swarm`
- `area: whisper`
- type
- `type: bug`
- `type: feature`
- `type: documentation`
- `type: discussion`
- status
- `status: PR review`
- `status: community working on it`
- need
- `need: more info`
- `need: steps to reproduce`
- `need: investigation`
- `need: decision`
Use these milestones
- [Future](https://github.com/ethereum/go-ethereum/milestone/80) - Maybe implement one day
- [Coming soon](https://github.com/ethereum/go-ethereum/milestone/81) - Not assigned to a specific release, but to be delivered in one of the upcoming releases
- \<next version\> - Next release with a version number
- \<next-next version\> - The version after the next release with a version number
- \<next major release\> - Optional.
It's ok to not set a due date for a milestone, but once you release it, close it. If you have a few issues dangling, consider moving them to the next milestone, and close this one.
Optionally, use a project board to collect issues of a larger effort that has an end state and overarches multiple releases.
## Workflow
The Geth core team hold a weekly or bi-weekly triage meeting. Issues are preselected by [labelling them "status:triage" and sorted the oldest ones first](https://github.com/ethereum/go-ethereum/issues?q=is%3Aopen+is%3Aissue+label%3Astatus%3Atriage+sort%3Acreated-asc). This is when the team goes through the new issues and do one of the following
2022-07-27 07:38:03 -05:00
1. Close it.
2. Assign it to "Coming soon" milestone which doesn't have an end date.
3. Move it to the "Future" milestone.
4. Change its status to "Need:\<what-is-needed\>".
2022-07-27 07:38:03 -05:00
Optional further activities:
2022-07-27 07:38:03 -05:00
* Label the issue with the appropriate area/component.
* Add a section to the FAQ or add a wiki page. Link to it from the issue.