You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/contribution-workflow.md
+38-11Lines changed: 38 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,17 +26,52 @@ finding an issue to getting your pull request merged.
26
26
Before starting work, find an appropriate issue to work on:
27
27
28
28
- Browse the [GitHub Issues](https://github.com/thunderbird/thunderbird-android/issues) for open issues
29
-
- Look for issues labeled [good first issue](https://github.com/thunderbird/thunderbird-android/labels/good%20first%20issue) if you're new to the project
29
+
- Prefer issues labeled [status: help wanted](https://github.com/thunderbird/thunderbird-android/labels/status%3A%20help%20wanted)
30
+
or [good first issue](https://github.com/thunderbird/thunderbird-android/labels/good%20first%20issue) if you're new
31
+
to the project
32
+
- Do not take issues labeled [tb-team](https://github.com/thunderbird/thunderbird-android/labels/tb-team); they are reserved
33
+
for maintainers
30
34
- Avoid issues labeled [unconfirmed](https://github.com/thunderbird/thunderbird-android/labels/unconfirmed) as they are not yet ready for contributions
31
35
32
36
### Requesting New Features / Ideas
33
37
34
-
We don’t track new ideas or feature requests in GitHub Issues. Mozilla connect is where feature proposals, product
38
+
We don’t track new ideas or feature requests in GitHub Issues. Mozilla Connect is where feature proposals, product
35
39
decisions, and larger design conversations happen.
36
40
37
41
- Start a discussion in [Mozilla Connect - Ideas](https://connect.mozilla.org/t5/ideas/idb-p/ideas/label-name/thunderbird%20android)
38
42
- Once a feature is accepted and work is planned, maintainers will create the corresponding GitHub issue(s).
39
43
44
+
### Working From GitHub Issues
45
+
46
+
GitHub Bug Issues track confirmed defects. GitHub Feature Issues and GitHub Task Issues track work that maintainers have
47
+
accepted and planned. New feature proposals still start in Mozilla Connect; maintainers create GitHub issues after a
48
+
proposal is accepted and scheduled.
49
+
50
+
External contributors should start from existing confirmed or planned issues:
51
+
52
+
- Use GitHub Bug Issues for confirmed defects.
53
+
- Use GitHub Feature Issues for accepted user-visible work.
54
+
- Use GitHub Task Issues for accepted supporting engineering work, such as refactoring, test infrastructure,
55
+
documentation, investigation, or technical planning.
56
+
- Prefer issues labeled `status: help wanted` or `good first issue`.
57
+
- Do not work on bug issues labeled `unconfirmed`; they still need maintainer triage.
58
+
- Do not take issues labeled `tb-team`; they are reserved for maintainers.
59
+
- Comment on the issue before coding and explain the part you want to work on.
60
+
- Wait until a maintainer assigns the issue to you before starting work.
61
+
- Do not open pull requests for large, cross-cutting, or unclear work without maintainer assignment and alignment in the
62
+
relevant issue.
63
+
64
+
If there is no matching issue:
65
+
66
+
- New feature ideas belong in [Mozilla Connect - Ideas](https://connect.mozilla.org/t5/ideas/idb-p/ideas/label-name/thunderbird%20android), not GitHub Issues.
67
+
- Bugs should be reported with the GitHub bug template.
68
+
- For technical work related to an existing issue, ask in that issue whether the contribution fits the current scope.
69
+
- If there is no related issue and the work is not a bug or Mozilla Connect feature idea, use the
70
+
[Matrix development channel](https://matrix.to/#/#tb-mobile-dev:mozilla.org) to ask where the work belongs before
71
+
starting.
72
+
73
+
Maintainers decide whether new GitHub Feature Issues, GitHub Task Issues, or GitHub Milestone Issues are needed.
74
+
40
75
### Reporting Bugs
41
76
42
77
If you’ve found a bug that’s not yet tracked:
@@ -50,15 +85,7 @@ Before coding:
50
85
1. Comment on the GitHub issue you want to work on.
51
86
2. Explain your intended approach.
52
87
3. For non-trivial changes, you may be asked to create a **[User Journey](../engineering/user-journeys/README.md)**, **[RFC](../engineering/rfcs/README.md)**, **[ADR](../engineering/adr/README.md)**, or **[Technical Design](../engineering/technical-designs/README.md)** to reach consensus before implementation.
53
-
4. Wait for maintainer feedback to ensure alignment and avoid duplicate work.
54
-
55
-
If the work appears larger than a single issue or pull request, or needs coordination across multiple features, tasks,
56
-
or contributors, ask maintainers whether it should be organized as a GitHub Milestone Issue. GitHub Milestone Issues are
57
-
created by core maintainers. See the [Engineering Delivery Planning guide](../engineering/delivery-planning.md) for
Copy file name to clipboardExpand all lines: docs/engineering/delivery-planning.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,12 +56,18 @@ If you are not a core maintainer:
56
56
57
57
1. Follow the [Contribution Workflow](../contributing/contribution-workflow.md) for finding an issue and
58
58
discussing your plan before coding.
59
-
2. If the work is already planned, contribute through the relevant GitHub Feature Issue or GitHub Task Issue.
59
+
2. If the work is already tracked, contribute through the relevant GitHub Bug Issue, GitHub Feature Issue, or GitHub
60
+
Task Issue. Prefer issues labeled `status: help wanted` or `good first issue`. Do not take issues labeled `tb-team`;
61
+
they are reserved for maintainers. Do not work on bug issues labeled `unconfirmed`; they still need maintainer
62
+
triage. For other GitHub Bug Issues, GitHub Feature Issues, or GitHub Task Issues, discuss the scope in the issue
63
+
and wait for a maintainer to assign the issue to you before starting.
60
64
3. If you want to propose a **new feature**, start a discussion in [Mozilla Connect](https://connect.mozilla.org/t5/ideas/idb-p/ideas/label-name/thunderbird%20android). Once accepted and planned, maintainers will create the corresponding GitHub issues.
61
-
4. If the work is a **technical task** (not a feature) that needs public tracking but is not milestone-sized, discuss your plan in an existing issue. If approved, ask maintainers to create the GitHub Task Issue for you. If there is no direct GitHub Milestone Issue match, mention the likely quarterly catch-all milestone in the issue or pull request. Maintainers link the issue to the milestone.
62
-
5. If the work proposes a broad technical direction, discuss your plan in an existing issue. If approved, ask maintainers to create a GitHub Task Issue proposing an RFC. That GitHub Task Issue is delivered by opening the pull request that adds the RFC.
63
-
6. If the work appears milestone-sized, ask maintainers to create a GitHub Milestone Issue instead of creating one yourself.
64
-
Use the [Matrix development channel](https://matrix.to/#/#tb-mobile-dev:mozilla.org) when you are unsure where to ask.
65
+
4. If you found a **bug** that is not tracked, open a GitHub issue using the bug template.
66
+
5. If technical work relates to an existing issue, discuss the scope in that issue before starting. Maintainers decide
67
+
whether a new GitHub Task Issue, RFC, ADR, Technical Design, or GitHub Milestone Issue is needed.
68
+
6. If there is no related issue and the work is not a bug or Mozilla Connect feature idea, use the
69
+
[Matrix development channel](https://matrix.to/#/#tb-mobile-dev:mozilla.org) to ask where the work belongs before
70
+
starting.
65
71
66
72
GitHub Milestone Issues are maintainer-owned. GitHub Feature Issues, GitHub Task Issues, RFC pull requests, and
67
73
implementation pull requests are the usual entry points for external contributors.
0 commit comments