Skip to content

Add section on merge ordering in dev guide #706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tshepang merged 1 commit into from
Jun 29, 2026
Merged

Add section on merge ordering in dev guide #706

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions src/dev-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,15 @@ Developer Guide

This document outlines the various formats, processes, and procedures associated with the maintenance of the FLS.

Text maintenance
----------------

Enumeration
-----------
~~~~~~~~~~~

When enumerating multiple entities, sort them alphabetically.

For example, in the sentence "A function item type implements Clone, Copy, Send, and Sync traits", the enumerated traits are sorted alphabetically.
For example, in the sentence "A function item type implements the Clone, Copy, Send, and Sync traits", the enumerated traits are sorted alphabetically.

Changelog maintenance
---------------------
Expand Down Expand Up @@ -92,3 +95,10 @@ Use the following sentence pattern for multiple syntax categories::
- :s:`syntax_category`

``<Action>`` must denote either ``Changed``, ``New``, or ``Removed``.

Merge ordering
--------------

To preserve the natural ordering of releases, merge all PRs related to release N before merging any PR related to release N+1.

This merging strategy will allow the FLS team to eventually tag commits in order to deliniate FLS releases.
Loading