Skip to content

docs: add engineering section#11072

Open
wmontwe wants to merge 14 commits into
thunderbird:mainfrom
wmontwe:docs-add-engineering-section
Open

docs: add engineering section#11072
wmontwe wants to merge 14 commits into
thunderbird:mainfrom
wmontwe:docs-add-engineering-section

Conversation

@wmontwe

@wmontwe wmontwe commented Jun 1, 2026

Copy link
Copy Markdown
Member

Resolves #11071

See the follow-up PR for a first example: #11073

@wmontwe wmontwe requested a review from a team as a code owner June 1, 2026 09:47
@wmontwe wmontwe requested a review from dani-zilla June 1, 2026 09:47
@wmontwe wmontwe requested a review from rafaeltonholo June 1, 2026 09:47
@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Validation Passed: All report and feature-flag labels are correctly set.

@github-actions github-actions Bot added the tb-team Tasks and features handled by project maintainers label Jun 1, 2026
@wmontwe wmontwe added the report: exclude Exclude changes from user-facing reports (internal, minor, or not relevant to users). label Jun 1, 2026
@wmontwe wmontwe requested a review from a team as a code owner June 1, 2026 09:55
@wmontwe wmontwe force-pushed the docs-add-engineering-section branch from 8b2ea13 to 106003f Compare June 1, 2026 09:59
@wmontwe wmontwe requested a review from jbott-tbird June 1, 2026 10:36
@wmontwe wmontwe force-pushed the docs-add-engineering-section branch 2 times, most recently from 3b13e9e to 2ac5d98 Compare June 2, 2026 10:07
@wmontwe

wmontwe commented Jun 2, 2026

Copy link
Copy Markdown
Member Author

I updated the engineering section by describing planning and milestones better. Additionally I clarified GitHub Milestone vs GitHub Milestone Issue.

Use an RFC when the team needs to agree on direction before implementation, especially when there are multiple reasonable
approaches, broad impact, or unclear scope.

RFCs are stored in the repository and reviewed through [pull requests](../contributing/contribution-workflow.md).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not against the idea of RFCs on GitHub. Usually when an organization does this though, two problems come up. First is that non-technical users don't know how to interact with GitHub to comment on proposed changes. However, I'm not sure that's as much of a concern here. We still may want to check with our non-engineering stakeholders and contributors, such as product owners and design.

Secondly, is the removal of the comments. Once the RFC goes through the pull request, it's pretty much a static ADR. You have to hunt down the pull request that submitted the file to read through the comments. It's not overly difficult, the file shouldn't have gone through enough changes, especially since future RFCs would get submitted and the ADR would stand as the final version, rather than revising old RFCs. However, preserving the comments, any proposed changes that were left behind, ideas we can come back to, that sort of thing, is a bit more difficult. We could, after submitting the PR, link to it in the doc to resolve that, but it does mean pushing a change to an RFC PR immediately after creating it.

None of these are blockers for this process, just something to think about. If we're inviting non-technical people to make comments and change requests on PRs, we may need some form of documentation on how that process is done (apologies if this already does that, I've not had a chance to review this entire PR yet).

@wmontwe wmontwe Jun 4, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, these are good points to call out.

The engineering docs, RFCs, ADRs, and technical designs are mainly intended for technical contributors and for preserving engineering decisions in a public, discoverable place. Broader product ideas and feature discussions should continue to happen on Mozilla Connect, which is the better entry point for users and non-engineering contributors.

Once an idea from Connect becomes a roadmap item, we usually move into a more structured phase: SoW, RFCs, ADRs, and technical designs. The goal is to move relevant project context into a persisted public form instead of leaving it only in places like Google Drive.

I intentionally left out a design-related process for now, since I think that should be discussed and defined together with design and product rather than being introduced as part of the engineering docs.

On preserving discussion: with our merge flow, the PR number is kept in the merge commit message, so there is still a way back to the original discussion. Linking the RFC PR from the document itself could be useful, but I would treat that as a nice-to-have rather than a blocker.

Comment thread docs/contributing/contribution-workflow.md
Comment thread docs/engineering/adr/README.md
Comment thread docs/engineering/technical-designs/README.md Outdated
Comment thread docs/engineering/delivery-planning.md Outdated
Comment thread docs/engineering/delivery-planning.md
wmontwe added 6 commits June 4, 2026 15:32
(cherry picked from commit 52d636c0225d5923260d906e2cc37e7213739020)
(cherry picked from commit 8d760f63e509a63d3a412939e8586c17e82ddfc8)
(cherry picked from commit b5cce6835900ad3c869e57016399e50e9d770da8)
(cherry picked from commit 7cf54f177f78c26350ff811605329a083db628f2)

^ Conflicts:
^	docs/SUMMARY.md
(cherry picked from commit c23a4c1f9f4100ff418b0a24d2aaee079f83d9ba)
wmontwe added 3 commits June 4, 2026 15:32
(cherry picked from commit 0f2ab7dbd01bca72420ef0a8d85c7bbc7acb5091)
(cherry picked from commit 5ddb2e39337e6477ff3c93096e70cbfd96b87f3e)
@wmontwe wmontwe force-pushed the docs-add-engineering-section branch from 2ac5d98 to d008468 Compare June 4, 2026 14:04
@wmontwe wmontwe force-pushed the docs-add-engineering-section branch from d008468 to 9d3f2be Compare June 4, 2026 14:31
@wmontwe wmontwe requested a review from rafaeltonholo June 5, 2026 07:54
@wmontwe wmontwe requested a review from dani-zilla June 5, 2026 07:54
Comment thread docs/engineering/adr/0000-adr-template.md Outdated
Comment thread README.md Outdated
Comment thread docs/engineering/delivery-planning.md Outdated
Comment thread docs/engineering/README.md Outdated
@wmontwe wmontwe requested a review from dani-zilla June 9, 2026 08:07
@wmontwe wmontwe force-pushed the docs-add-engineering-section branch from 964076a to 1563bfd Compare June 9, 2026 08:11

@dani-zilla dani-zilla left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so incredibly useful. Love to see the process laid out with this level of detail and even examples. 👍

@rafaeltonholo rafaeltonholo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!! Thanks for this awesome documentation!

@wmontwe

wmontwe commented Jun 10, 2026

Copy link
Copy Markdown
Member Author

@coreycb, @thunderbird/build-release This needs your review as I touched the pull request template.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

report: exclude Exclude changes from user-facing reports (internal, minor, or not relevant to users). tb-team Tasks and features handled by project maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add engineering documentation with RFC and technical design templates

4 participants