Reference new contributing guidelines#603
Conversation
WalkthroughThe CONTRIBUTING.md file was updated by removing the detailed contribution instructions and replacing them with a single line that directs contributors to an external webpage for guidance on contributing to the project. Changes
Sequence Diagram(s)No sequence diagram is necessary for this documentation update. Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
55-55: Refine the link text for consistency.
For a cleaner and more professional look, use title case and a single-word “Codebase,” e.g.:
[Contributing to Our Open Codebase](https://learningequality.org/contributing-to-our-open-code-base)
This aligns with the project’s naming conventions.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🔇 Additional comments (1)
CONTRIBUTING.md (1)
1-177: Verify other documentation references.
After centralizing contribution instructions here, please audit README.md, docs/ folder, and any in-repo scripts or templates for outdated “how to contribute” sections. Update or remove them to consistently point to the new external page.🧰 Tools
🪛 LanguageTool
[typographical] ~4-~4: Consider isolating this adverbial phrase with commas.
Context: ...ions to this project are welcome and are in fact greatly appreciated! Every little bit h...(IN_FACT_COMMA_2)
[misspelling] ~6-~6: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... a junior Python programmer looking for a open source project to contribute to, a...(EN_A_VS_AN)
[uncategorized] ~6-~6: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... junior Python programmer looking for a open source project to contribute to, an advanced p...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~20-~20: This phrase is duplicated. You should probably use “Report Bugs” only once.
Context: ...e learners from around the world. ### Report Bugs Report bugs at [https://github.com/learningequality...(PHRASE_REPETITION)
[style] ~60-~60: Consider a more concise word here.
Context: ...----------------- Ready to contribute? In order to work on thericecookercode you'll fi...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...e? In order to work on thericecookercode you'll first need to make you have [Pyt...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~84-~84: The verb ‘depend’ requires the preposition ‘on’ (or ‘upon’).
Context: ...irtualenv ``` * The next steps depends if you're using a UNIX system (Mac/Linu...(DEPEND_ON)
[uncategorized] ~104-~104: Possible missing comma found.
Context: ...ersion of Python is located. Note you'll need Python version 3.5 or highe...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
14-14: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
20-20: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
31-31: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
37-37: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
49-49: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
72-72: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
80-80: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
88-88: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
92-92: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
100-100: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
106-106: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
112-112: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
119-119: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
129-129: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
140-140: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
174-174: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
175-175: Dollar signs used before commands without showing output
null(MD014, commands-show-output)
|
|
||
|
|
||
|
|
||
| To find out how to contribute, visit the [Contributing to our open code base](https://learningequality.org/contributing-to-our-open-code-base). |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Remove redundant in-file instructions.
The detailed “Becoming a ricecooker developer” section that follows now duplicates content available on the external guidelines page. To maintain a single source of truth and avoid confusion, remove lines 57–156 (or up to the “Pull Request Guidelines” heading), leaving only this pointer to the external site.
|
Closing in favor of learningequality/.github#27. I will open a new PR in this repo to remove the issue templates. |
2 participants
Summary
Reference new contributing guidelines and remove obsolete or duplicate information
Reviewer guidance
Summary by CodeRabbit