You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .CONTRIBUTING/.CONTRIBUTING.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,6 +67,8 @@ Follow these steps when contributing documentation fixes, improvements, or new c
67
67
python3 scripts/generate_llms_standard.py
68
68
```
69
69
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.
70
72
71
73
4.**Create Pull Request**
72
74
- Push your branch and create a pull request
@@ -78,17 +80,21 @@ Follow these steps when contributing documentation fixes, improvements, or new c
78
80
-**Option A**: "I have time to handle formatting and style review feedback myself"
79
81
-**Option B**: "Please have the Polkadot docs team take over for formatting review to expedite the process"
80
82
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
82
86
83
87
### Hand-off Process (Internal Team Workflow)
84
88
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:
86
90
87
91
1.**Create Intermediary Branch**: Create a new branch named `follow-up/PR-[original_pr_number]`
88
92
2.**Redirect Original PR**: Change the destination of the original PR to the intermediary branch
89
93
3.**Complete Formatting Review**: Perform style and formatting reviews on the intermediary branch
90
94
4.**Final Merge**: Merge the completed intermediary branch into master
91
95
96
+
If the contributor selects Option B AND allows edits from maintainers then we can perform changes directly on the contributor's branch.
97
+
92
98
## Generating AI-Ready Documentation
93
99
94
100
When you modify content in the documentation, you should regenerate the AI-ready files to keep them current:
0 commit comments