Skip to content

Commit c697784

Browse files
[Dev-Guide]: Dealing with PR blockers
1 parent f7b0d87 commit c697784

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

src/dev-guide.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,30 @@ Use the following sentence pattern for multiple syntax categories::
9696

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

99+
Dealing with PR blockers
100+
------------------------
101+
102+
Incorrect or incomplete semantics
103+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104+
105+
While working on a PR, a developer may need to modify existing FLS semantics or terminology, only for the developer to discover that these semantics or terms are either incorrect or incomplete.
106+
In such cases, bring up the issue during one of the FLS team meetings.
107+
108+
Depending on the scope of the required changes, the FLS team may decide to either:
109+
- Enact the necessary changes in the same PR-in-development, or
110+
- Approximate the contents of the PR-in-development, and open a GitHub issue to track the update on the semantics or terms.
111+
112+
Missing semantics
113+
~~~~~~~~~~~~~~~~~
114+
115+
While working on a PR, a developer may need to modify existing FLS semantics or use existing terminology, only for the developer to discover that these semantics or terms are missing.
116+
This may happen when the Rust Reference or other sources the FLS team may use as reference were changed irrespective of Rust releases.
117+
In such cases, bring up the issue during one of the FLS team meetings.
118+
119+
Depending on the scope of the required changes, the FLS team may decide to either:
120+
- Enact the necessary changes in the same PR, or
121+
- Create a separate PR to introduce the missing semantics or terms, and then update the contents of the PR-in-development.
122+
99123
Merge ordering
100124
--------------
101125

0 commit comments

Comments
 (0)