Issue #431 resolved : docs: Added CONTRIBUTING.md, updated README.md , and included Code of Conduct.md#450
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughTwo new documentation files, Changes
Assessment against linked issues
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
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 (
|
|
@rahulharpal1603 Due to some errors I wasn't able to make changes in the existing PR but this PR Is updated with the required changes kindly review. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
README.md (1)
58-62: Horizontal rule renders, but consider an H2/H3 header for discoverabilityUsing
---is technically correct, yet it hides the “Contributing” entry in long READMEs because it’s not a heading. Replacing the rule with a second-level header, e.g.## Contributing, improves TOC generation in GitHub UI without changing semantics.CONTRIBUTING.md (2)
16-18: Invalid HTML tag and unnecessary<br>
</br>is not a valid self-closing break tag in HTML/Markdown and breaks some MD renderers. A blank line is enough.- </br>Remove the line or replace with a blank line.
45-52: Minor grammar – missing article “the”“Set the public key in tauri.conf.json as pubkey and private key and password in Environment Variables …”
Suggested rewrite:
-Set the public key in tauri.conf.json as pubkey and private key and password in Environment Variables as TAURI_SIGNING_PRIVATE_KEY and TAURI_SIGNING_PRIVATE_KEY_PASSWORD +Set the public key in `tauri.conf.json` as `pubkey`, and place the private key and its password in the environment variables `TAURI_SIGNING_PRIVATE_KEY` and `TAURI_SIGNING_PRIVATE_KEY_PASSWORD`.CODE_OF_CONDUCT.md (1)
119-128: Bare URLs lint warnings – wrap in markdown links
markdownlintflags bare URLs. To silence lint and improve readability, wrap them:-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[Contributor Covenant v2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html)(Apply similarly to the FAQ and translations links.)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CODE_OF_CONDUCT.md(1 hunks)CONTRIBUTING.md(1 hunks)README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~51-~51: You might be missing the article “the” here.
Context: ...ic key in tauri.conf.json as pubkey and private key and password in Environment Variabl...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
CODE_OF_CONDUCT.md
[style] ~32-~32: Try using a synonym here to strengthen your wording.
Context: ...ind * Trolling, insulting or derogatory comments, and personal or political attacks * Pu...
(COMMENT_REMARK)
[uncategorized] ~120-~120: You might be missing the article “the” here.
Context: ....org/version/2/0/code_of_conduct.html. Community Impact Guidelines were inspired by [Moz...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
CODE_OF_CONDUCT.md
63-63: Bare URL used
(MD034, no-bare-urls)
119-119: Bare URL used
(MD034, no-bare-urls)
127-127: Bare URL used
(MD034, no-bare-urls)
128-128: Bare URL used
(MD034, no-bare-urls)
| Set the public key in tauri.conf.json as pubkey and private key and password in Environment Variables as TAURI_SIGNING_PRIVATE_KEY and TAURI_SIGNING_PRIVATE_KEY_PASSWORD | ||
|
|
||
| There is a preset pubkey in tauri.conf.json ; private key and password for it is: | ||
|
|
||
| ```bash | ||
| TAURI_SIGNING_PRIVATE_KEY=dW50cnVzdGVkIGNvbW1lbnQ6IHJzaWduIGVuY3J5cHRlZCBzZWNyZXQga2V5ClJXUlRZMEl5NlF2SjE3cWNXOVlQQ0JBTlNITEpOUVoyQ3ZuNTdOSkwyNE1NN2RmVWQ1a0FBQkFBQUFBQUFBQUFBQUlBQUFBQU9XOGpTSFNRd0Q4SjNSbm5Oc1E0OThIUGx6SS9lWXI3ZjJxN3BESEh1QTRiQXlkR2E5aG1oK1g0Tk5kcmFzc0IvZFZScEpubnptRkxlbDlUR2R1d1Y5OGRSYUVmUGoxNTFBcHpQZ1dSS2lHWklZVHNkV1Byd1VQSnZCdTZFWlVGOUFNVENBRlgweUU9Cg== | ||
| ``` | ||
|
|
||
| ```bash | ||
| TAURI_SIGNING_PRIVATE_KEY_PASSWORD=pass | ||
| ``` |
There was a problem hiding this comment.
Private signing key & password should not be committed
Even if this is a demo key, publishing TAURI_SIGNING_PRIVATE_KEY and its password trains contributors to commit secrets. Move the example to a snippet with obviously bogus values (e.g. BASE64_PRIVATE_KEY_HERE) or link to Tauri docs instead.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~51-~51: You might be missing the article “the” here.
Context: ...ic key in tauri.conf.json as pubkey and private key and password in Environment Variabl...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🤖 Prompt for AI Agents
In CONTRIBUTING.md around lines 51 to 61, the private signing key and password
are included as actual values, which encourages committing secrets. Replace the
real base64 private key and password with clearly fake placeholder values like
BASE64_PRIVATE_KEY_HERE and YOUR_PASSWORD_HERE, or remove them entirely and
instead provide a link to the official Tauri documentation for setting these
environment variables securely.
| - Docker Compose Setup: [Guide](./docs/docker-compose/redme.md) | ||
| - Setup using Dockerfile |
There was a problem hiding this comment.
Broken link: redme.md typo will 404
./docs/docker-compose/redme.md is misspelled – should be README.md.
- - Docker Compose Setup: [Guide](./docs/docker-compose/redme.md)
+ - Docker Compose Setup: [Guide](./docs/docker-compose/README.md)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Docker Compose Setup: [Guide](./docs/docker-compose/redme.md) | |
| - Setup using Dockerfile | |
| - Docker Compose Setup: [Guide](./docs/docker-compose/README.md) | |
| - Setup using Dockerfile |
🤖 Prompt for AI Agents
In CONTRIBUTING.md around lines 13 to 14, the link to the Docker Compose Setup
guide has a typo in the filename `redme.md`. Correct the filename in the link to
`README.md` to fix the broken link and prevent 404 errors.
|
also I haven't modified anything as you suggested earlier have only moved the content from README to CONTRIBUTING.md |
|
@ssz2605 Thank you the PR! |
|
@rahulharpal1603 Thanks! Looking forward to more contributions. |
2 participants
📚 Summary
This PR improves the project documentation for better onboarding and contribution clarity. The following changes have been made:
✍️ Added
CONTRIBUTING.md:Includes detailed setup instructions, Git workflow for PRs, and contribution guidelines for new contributors.
📘 Updated
README.md:Cleaned up previous content and added a reference to the new
CONTRIBUTING.mdfor streamlined navigation.📄 Added
CODE_OF_CONDUCT.md:Defines community standards for respectful and inclusive collaboration.
✅ Checklist
CONTRIBUTING.mdcreated with setup & PR instructionsREADME.mdupdated with proper linksCODE_OF_CONDUCT.mdadded for community standardsLooking forward to your feedback! 🙂
closes #431
Summary by CodeRabbit