Add Contributing Page #93
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Caution Review failedThe pull request is closed. WalkthroughThis pull request introduces a new contributing guide located in Changes
Sequence Diagram(s)sequenceDiagram
participant C as Contributor
participant G as GitHub
participant R as Repository
participant M as Maintainer
C->>G: Fork repository
G-->>C: Forked repository URL
C->>G: Clone repository locally
C->>R: Create feature branch
C->>R: Make changes & run tests
C->>G: Push branch & open pull request
G->>M: Notify maintainers of new PR
M->>C: Review & provide feedback
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
Note 🎁 Summarized by CodeRabbit FreeYour organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (4)
pages/contributing.mdx (4)
9-10: Content Style & Clarity Suggestion
In the opening paragraph, consider hyphenating "Open Source" when used as a compound adjective (e.g., "open‑source project") and review the punctuation before “or” for better readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...f this is your first contribution to an Open Source project or you're a core maintainer of ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~10-~10: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...t contribution to an Open Source project or you're a core maintainer of multiple pr...(COMMA_COMPOUND_SENTENCE)
19-23: Link Text Consistency Recommendation
The section "## Read the developers guide" clearly directs users to the developer guide. For consistency, you might consider a possessive form (e.g., "Developer’s Guide") in the link text.🧰 Tools
🪛 LanguageTool
[grammar] ~22-~22: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...ng of the project structure, and how to setup your development environment. Read this...(NOUN_VERB_CONFUSION)
30-32: Duplicate Link Notice in Discord Section
The bullet item for Discord chat repeats the link text (it appears twice). Consider simplifying this bullet point and rephrasing it, for example:Discord chat: Chat with the community and receive quicker feedback.
This will improve clarity and remove redundancy.
45-63: Step-by-Step Instructions: Numbering Consistency & Minor Typo
- The steps in the "How to contribute" section are not sequentially numbered (e.g., 1, 2, 3, 6, 7, 9, etc.). Renumbering them can improve clarity.
- In step 10, the phrase "Option 1: Use the Deleoper environment" contains a typo ("Deleoper"). It should be "Developer environment".
🧰 Tools
🪛 LanguageTool
[misspelling] ~59-~59: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...`
9. Create a pull request: Create an draft pull request with the name of the...(EN_A_VS_AN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/contributing.mdx(1 hunks)pages/developer-guide.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
pages/contributing.mdx
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...f this is your first contribution to an Open Source project or you're a core maintainer of ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~10-~10: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...t contribution to an Open Source project or you're a core maintainer of multiple pr...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~22-~22: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...ng of the project structure, and how to setup your development environment. Read this...
(NOUN_VERB_CONFUSION)
[uncategorized] ~27-~27: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...## Write code with others
This is an open source project, with an open and welcoming com...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[misspelling] ~59-~59: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...`
9. Create a pull request: Create an draft pull request with the name of the...
(EN_A_VS_AN)
🪛 GitHub Actions: Build static docs
pages/contributing.mdx
[error] 1-1: Build failed because of webpack errors: Module not found: Can't resolve '../../components/snippets/earlydoc.mdx'
🔇 Additional comments (2)
pages/developer-guide.mdx (1)
51-51: Relative Link Update Validated
The updated link to the contributors guide (./contributing) is correct and aligns with the new file added. Please verify that the relative path correctly resolves topages/contributing.mdxin all build contexts.pages/contributing.mdx (1)
1-3: YAML Metadata Looks Good
The metadata block correctly sets the title for the page. No issues here.🧰 Tools
🪛 GitHub Actions: Build static docs
[error] 1-1: Build failed because of webpack errors: Module not found: Can't resolve '../../components/snippets/earlydoc.mdx'
pages/contributing.mdx
Outdated
| title: Contributing | ||
| --- | ||
|
|
||
| import EarlyDoc from "../../components/snippets/earlydoc.mdx"; |
There was a problem hiding this comment.
Module Import Issue: File Not Found
The import statement
import EarlyDoc from "../../components/snippets/earlydoc.mdx";is causing a webpack error ("Module not found: Can't resolve '../../components/snippets/earlydoc.mdx'"). Please verify whether the file exists at the given path or update/remove this import if it is not needed.
Issue: gitroomhq/postiz-docs#703
Summary by CodeRabbit
Summary by CodeRabbit