Skip to content

Commit 5658cdd

Browse files
update contributing path
1 parent 970837a commit 5658cdd

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

.CONTRIBUTING/.CONTRIBUTING.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ Follow these steps when contributing documentation fixes, improvements, or new c
6767
python3 scripts/generate_llms_standard.py
6868
```
6969
This updates the `llms.txt` and `llms-full.txt` files that power our AI-ready documentation.
70+
71+
**Note**: This script needs to be run on every PR once all changes have been committed.
7072

7173
4. **Create Pull Request**
7274
- Push your branch and create a pull request
@@ -78,17 +80,21 @@ Follow these steps when contributing documentation fixes, improvements, or new c
7880
- **Option A**: "I have time to handle formatting and style review feedback myself"
7981
- **Option B**: "Please have the Polkadot docs team take over for formatting review to expedite the process"
8082

81-
**If choosing Option B**: You must also enable "Allow edits from maintainers" when creating your PR (this option appears for PRs from forks). This allows our team to create a follow-up branch and handle style/formatting changes, letting you focus on the technical content.
83+
**If choosing Option B**:
84+
- If you enable "Allow edits from maintainers" when creating your PR (this option appears for PRs from forks), our team can perform changes directly on your branch
85+
- If "Allow edits from maintainers" is not enabled, we will create the `follow-up/PR-[original_pr_number]` branch and go through the intermediary workflow described below
8286

8387
### Hand-off Process (Internal Team Workflow)
8488

85-
When a contributor chooses Option B or becomes unresponsive during review:
89+
When a contributor chooses Option B but does not have "Allow edits from maintainers" enabled, or when a contributor (regardless of option chosen) becomes unresponsive during review:
8690

8791
1. **Create Intermediary Branch**: Create a new branch named `follow-up/PR-[original_pr_number]`
8892
2. **Redirect Original PR**: Change the destination of the original PR to the intermediary branch
8993
3. **Complete Formatting Review**: Perform style and formatting reviews on the intermediary branch
9094
4. **Final Merge**: Merge the completed intermediary branch into master
9195

96+
If the contributor selects Option B AND allows edits from maintainers then we can perform changes directly on the contributor's branch.
97+
9298
## Generating AI-Ready Documentation
9399

94100
When you modify content in the documentation, you should regenerate the AI-ready files to keep them current:

0 commit comments

Comments
 (0)