diff --git a/src/dev-guide.rst b/src/dev-guide.rst index b52d574e..db0bd419 100644 --- a/src/dev-guide.rst +++ b/src/dev-guide.rst @@ -96,6 +96,30 @@ Use the following sentence pattern for multiple syntax categories:: ```` must denote either ``Changed``, ``New``, or ``Removed``. +Dealing with PR blockers +------------------------ + +Incorrect or incomplete semantics +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +While working on a PR, a developer may discover that the PR depends on semantics or terminology that are either incorrect or incomplete in the FLS. +In such cases, bring up the issue to the FLS team. + +Depending on the scope of the required changes, the FLS team may decide to either: +- Enact the necessary changes in the same PR-in-development, or +- Defer the pre-existing out-of-scope problem only when the PR-in-development remains accurate within its stated scope, and open GitHub issue to track the problem. + +Missing semantics +~~~~~~~~~~~~~~~~~ + +While working on a PR, a developer may discover that the PR depends on semantics or terminology that the FLS does not yet define. +This may happen when the Rust Reference or other sources the FLS team may use as reference were changed irrespective of Rust releases. +In such cases, bring up the issue to the FLS team. + +Depending on the scope of the required changes, the FLS team may decide to either: +- Enact the necessary changes in the same PR, or +- Create a separate PR to introduce the missing semantics or terms, and then update the contents of the PR-in-development. + Merge ordering --------------