Reference new contributing guidelines #13389
Conversation
MisRob
force-pushed
the
contributing-guidelines
branch
from
effacb9 to
2fd81bc
Compare
WalkthroughThe contribution documentation was streamlined by removing detailed, step-by-step guidance and consolidating all instructions into a single welcoming statement with a link to an external contribution resource. References to specific support channels and internal documentation were replaced or removed, centralizing contribution information outside the repository. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant Repository
participant ExternalContributionGuide
Contributor ->> Repository: Seeks contribution information
Repository -->> Contributor: Provides link to ExternalContributionGuide
Contributor ->> ExternalContributionGuide: Accesses detailed instructions
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
MisRob
force-pushed
the
contributing-guidelines
branch
from
2fd81bc to
5c5d056
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (1)
37-37: Approve central contribution link.Shifting to the external “Contributing to our open code base” page simplifies maintenance.
Consider appending a trailing slash to the URL for consistency with other docs:
https://learningequality.org/contributing-to-our-open-code-base/CONTRIBUTING.md (2)
4-4: Approve simplified welcome prompt.The new, brief greeting is inviting and keeps the file focused.
Optionally, align this phrasing with the RST doc’s “Contributions are welcome...” for a consistent tone across documentation.
6-6: Approve external contribution link in CONTRIBUTING.md.Correctly directs contributors to the centralized guidelines, reducing duplication.
For consistency, you may want to include a trailing slash on the URL:
https://learningequality.org/contributing-to-our-open-code-base/
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CONTRIBUTING.md(1 hunks)README.md(1 hunks)docs/contributing/ways_to_contribute.rst(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~35-~35: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 1920 characters long)
Context: ...n I contribute? We welcome contributors! To find out how to contribute, visit t...
(EN_EXCESSIVE_EXCLAMATION)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: All file linting
- GitHub Check: Build WHL file / Build WHL
🔇 Additional comments (2)
docs/contributing/ways_to_contribute.rst (1)
37-37: Approve externalizing contribution guidance.The “Write code” section now cleanly delegates contributor instructions to the external resource, keeping the docs concise and up-to-date.
README.md (1)
35-35: Approve concise contributor welcome message.This succinct greeting replaces the lengthy instructions and aligns with the streamlined contribution flow.
🧰 Tools
🪛 LanguageTool
[style] ~35-~35: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 1920 characters long)
Context: ...n I contribute? We welcome contributors! To find out how to contribute, visit t...(EN_EXCESSIVE_EXCLAMATION)
Build Artifacts
|
rtibbles
left a comment
rtibbles
left a comment
There was a problem hiding this comment.
Slight wording revision needed.
|
Thanks @rtibbles. I removed 'the' in learningequality/.github#25. After we merge that, we can see how it works and then I will complete this PR. |
|
That PR has been merged! |
In favour of the default .github/.github/CONTRIBUTING.md
Also disables the default blank issue in favor of the new custom blank issue template to allow it to have the header too.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
.github/ISSUE_TEMPLATE/product_issue.md (1)
8-16: Standardize HTML comment delimitersThe header is enclosed with triple hyphens in your HTML comments (
<!---HEADER START-->). For consistency and clarity, consider using the standard HTML comment format with single hyphens and spaces:-<!---HEADER START--> +<!-- HEADER START --> ... -<!---HEADER END--> +<!-- HEADER END -->🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Images should have alternate text (alt text)
null(MD045, no-alt-text)
14-14: Images should have alternate text (alt text)
null(MD045, no-alt-text)
README.md (1)
34-37: Tone down punctuation for consistencyThe welcome statement uses an exclamation mark, which may appear overly emphatic compared to the rest of the documentation style. Consider a neutral tone:
-We welcome contributors! +We welcome contributors.Or:
-We welcome contributors! +Welcome contributors.🧰 Tools
🪛 LanguageTool
[style] ~34-~34: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 1915 characters long)
Context: ...n I contribute? We welcome contributors! To find out how to contribute, visit [...(EN_EXCESSIVE_EXCLAMATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
.github/ISSUE_TEMPLATE/blank_issue.md(1 hunks).github/ISSUE_TEMPLATE/bug_report.md(1 hunks).github/ISSUE_TEMPLATE/config.yml(1 hunks).github/ISSUE_TEMPLATE/product_issue.md(1 hunks)CONTRIBUTING.md(0 hunks)README.md(1 hunks)
💤 Files with no reviewable changes (1)
- CONTRIBUTING.md
✅ Files skipped from review due to trivial changes (3)
- .github/ISSUE_TEMPLATE/config.yml
- .github/ISSUE_TEMPLATE/bug_report.md
- .github/ISSUE_TEMPLATE/blank_issue.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.github/ISSUE_TEMPLATE/product_issue.md
10-10: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
14-14: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
🪛 LanguageTool
README.md
[style] ~34-~34: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 1915 characters long)
Context: ...n I contribute? We welcome contributors! To find out how to contribute, visit [...
(EN_EXCESSIVE_EXCLAMATION)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build WHL file / Build WHL
|
|
||
| <!---HEADER START--> | ||
|
|
||
| <img height="20px" src="https://i.imgur.com/c7hUeb5.jpeg"> |
There was a problem hiding this comment.
Add alt text to images for accessibility
Images at lines 10 and 14 lack alt attributes, which is an accessibility requirement (MD045). Please add descriptive alternative text to each image, for example:
-<img height="20px" src="https://i.imgur.com/c7hUeb5.jpeg">
+<img alt="warning icon" height="20px" src="https://i.imgur.com/c7hUeb5.jpeg">Also applies to: 14-14
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In .github/ISSUE_TEMPLATE/product_issue.md at lines 10 and 14, the <img> tags
are missing alt attributes, which are necessary for accessibility compliance.
Add descriptive alt text to each image tag by including an alt="description"
attribute that clearly describes the image content.
|
@rtibbles learningequality/.github#25 works as expected, one example of being it referenced correctly is at https://github.com/learningequality/test-actions/contribute. I updated this PR to
After we merge this and learningequality/.github#26, I will update remaining repositories and also open pull requests to turn on the header automation. |
|
I have approved the PRs, feel free to merge when appropriate! |
2 participants
Summary
Reference new contributing guidelines and remove obsolete or duplicate information
Reviewer guidance
Summary by CodeRabbit