docs: Create CONTRIBUTING.md #325
Conversation
Summary by CodeRabbit
WalkthroughAdds a new CONTRIBUTING.md with detailed contribution guidelines, including issue/PR processes, commit message conventions, PR workflow steps, and references to community support channels. CLA-related notes are included as commented-out sections. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (8)
CONTRIBUTING.md (8)
169-175: Add language identifiers to fenced code blocks (MD040).Label the non-code commit-message examples as
text.Apply this diff:
-``` +```text <type>(<scope>): <subject> <BLANK LINE> <body> <BLANK LINE> <footer> -``` +```-``` +```text docs(changelog): update change log to beta.5 fix(core): need to depend on latest rxjs and zone.js -``` +```Also applies to: 186-189
162-163: Brand/style consistency: “Tinh Tinh changelog”.Minor wording cleanup.
Apply this diff:
-we use the git commit messages to **generate the TinhTinh change log**. +we use the git commit messages to **generate the Tinh Tinh changelog**.
123-125: Make the force-push instruction explicit.Specify remote and branch to reduce mistakes.
Apply this diff:
- git rebase master -i - git push -f + git rebase master -i + git push -f origin my-fix-branch
131-133: Avoid “main (upstream)” wording since the branch here is master.This prevents confusion about the default branch name.
Apply this diff:
-After your pull request is merged, you can safely delete your branch and pull the changes -from the main (upstream) repository: +After your pull request is merged, you can safely delete your branch and pull the changes +from the upstream repository:Please confirm the repository’s default branch is indeed “master” everywhere (PR target shows master). If “main” is used elsewhere, align consistently.
152-156: Add the missing step to add the upstream remote before pulling.Many contributors won’t have
upstreamconfigured yet.Apply this diff:
```shell + # If you haven't added the upstream remote yet: + # git remote add upstream https://github.com/tinh-tinh/tinhtinh.git git pull --ff upstream master--- `207-207`: **Typo/style: “semicolons” and period after etc.** Minor polish. Apply this diff: ```diff -- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) +- **style**: Changes that do not affect the meaning of the code (whitespace, formatting, missing semicolons, etc.)
266-267: Verify the Discord invite URL.Discord often rotates invites and prefers discord.gg. Ensure the link is valid and non-expiring.
I can replace it with a vanity or permanent invite once you confirm the correct URL.
248-256: Consider removing long commented-out CLA sections or linking a real CLA.If CLA isn’t planned soon, trimming commented blocks reduces noise; if planned, add a live link.
Happy to craft a shorter placeholder section that won’t confuse contributors.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[grammar] ~9-~9: There might be a mistake here.
Context: ... Problem?](#question) - Issues and Bugs - Feature Requests - [Submissio...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...es and Bugs](#issue) - Feature Requests - Submission Guidelines - [Commi...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...ests](#feature) - Submission Guidelines - Commit Message Guidelines <!...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...w] where the questions should be tagged with tag tinhtinh. Stack Overflow is a mu...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...estion / answer might help someone else. - Stack Overflow's voting system assures t...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...epository][github]. Even better, you can submit a Pull Request with...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...g an issue](#submit-issue) to our GitHub Repository. If you would like to implement a new...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ...new feature, please submit an issue with a proposal for your work first, to be su...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ...rk first, to be sure that we can use it. Please consider what kind of change it i...
(QB_NEW_EN)
[style] ~57-~57: Consider a more concise word here.
Context: ...ug we need to reproduce and confirm it. In order to reproduce bugs we will systematically a...
(IN_ORDER_TO_PREMIUM)
[grammar] ~57-~57: There might be a mistake here.
Context: ...ing a live, reproducible scenario gives us wealth of important information without...
(QB_NEW_EN)
[grammar] ~59-~59: There might be a mistake here.
Context: ...tions like: - version of Tinh Tinh used - 3rd-party libraries and their versions -...
(QB_NEW_EN)
[style] ~70-~70: As a shorter alternative for ‘able to’, consider using “can not”.
Context: ...e we can fix it. --> Unfortunately, we are not able to investigate / fix bugs without a minima...
(BE_ABLE_TO)
[grammar] ~97-~97: There might be a mistake here.
Context: ...ts)), and ensure that all tests pass. 1. Commit your changes using a descriptive ...
(QB_NEW_EN)
[grammar] ~131-~131: There might be a mistake here.
Context: ... delete your branch and pull the changes from the main (upstream) repository: - ...
(QB_NEW_EN)
[grammar] ~161-~161: There might be a mistake here.
Context: ...rough the project history. But also, we use the git commit messages to **gene...
(QB_NEW_EN)
[grammar] ~166-~166: There might be a mistake here.
Context: ...d a footer. The header has a special format that includes a type, a **sco...
(QB_NEW_EN)
[grammar] ~179-~179: There might be a mistake here.
Context: ...rs! This allows the message to be easier to read on GitHub as well as in various ...
(QB_NEW_EN)
[grammar] ~199-~199: There might be a mistake here.
Context: ...es (example scopes: gulp, broccoli, npm) - chore: Updating tasks etc; no producti...
(QB_NEW_EN)
[grammar] ~200-~200: There might be a mistake here.
Context: ...ing tasks etc; no production code change - ci: Changes to our CI configuration fi...
(QB_NEW_EN)
[grammar] ~201-~201: There might be a mistake here.
Context: ...Travis, Circle, BrowserStack, SauceLabs) - docs: Documentation only changes - **f...
(QB_NEW_EN)
[grammar] ~202-~202: There might be a mistake here.
Context: ...) - docs: Documentation only changes - feat: A new feature - fix: A bug f...
(QB_NEW_EN)
[grammar] ~203-~203: There might be a mistake here.
Context: ...n only changes - feat: A new feature - fix: A bug fix - perf: A code chan...
(QB_NEW_EN)
[grammar] ~204-~204: There might be a mistake here.
Context: ...at**: A new feature - fix: A bug fix - perf: A code change that improves perf...
(QB_NEW_EN)
[grammar] ~205-~205: There might be a mistake here.
Context: ... A code change that improves performance - refactor: A code change that neither f...
(QB_NEW_EN)
[grammar] ~206-~206: There might be a mistake here.
Context: ...t neither fixes a bug nor adds a feature - style: Changes that do not affect the ...
(QB_NEW_EN)
[style] ~207-~207: In American English, abbreviations like “etc.” require a period.
Context: ...space, formatting, missing semi-colons, etc) - test: Adding missing tests or co...
(ETC_PERIOD)
[grammar] ~207-~207: There might be a mistake here.
Context: ...e, formatting, missing semi-colons, etc) - test: Adding missing tests or correcti...
(QB_NEW_EN)
[grammar] ~208-~208: There might be a mistake here.
Context: ...ssing tests or correcting existing tests - sample: A change to the samples ### S...
(QB_NEW_EN)
[grammar] ~213-~213: There might be a mistake here.
Context: ... the npm package affected (as perceived by person reading changelog generated from...
(QB_NEW_EN)
[grammar] ~213-~213: There might be a mistake here.
Context: ...ackage affected (as perceived by person reading changelog generated from commit message...
(QB_NEW_EN)
[grammar] ~217-~217: There might be a mistake here.
Context: ...: for changes made on common directory - core: for changes made on core direc...
(QB_NEW_EN)
[grammar] ~218-~218: There might be a mistake here.
Context: ...**: for changes made on core directory - microservices: for changes made on `mi...
(QB_NEW_EN)
[grammar] ~219-~219: There might be a mistake here.
Context: ...hanges made on microservices directory - dto: for changes made on dto directo...
(QB_NEW_EN)
[grammar] ~220-~220: There might be a mistake here.
Context: ...o**: for changes made on dto directory - middleware: for changes made on `middl...
(QB_NEW_EN)
[grammar] ~221-~221: There might be a mistake here.
Context: ...r changes made on middleware directory - router: for changes made on router d...
(QB_NEW_EN)
[grammar] ~228-~228: There might be a mistake here.
Context: ...ommon,core`). ### Subject The subject contains succinct description of the change: - ...
(QB_NEW_EN)
[grammar] ~241-~241: There might be a mistake here.
Context: ...aking Changes** and is also the place to reference GitHub issues that this commit...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
95-95: Link fragments should be valid
(MD051, link-fragments)
96-96: Link fragments should be valid
(MD051, link-fragments)
169-169: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
186-186: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Analyze (go)
🔇 Additional comments (1)
CONTRIBUTING.md (1)
1-14: Solid first pass—clear structure and actionable guidance.The document is well organized and sets clear expectations for contributors. Nice touch including commit message conventions and PR workflow.
| 1. Follow our [Coding Rules](#rules). | ||
| 1. Run the full Tinh Tinh test suite (see [common scripts](#common-scripts)), | ||
| and ensure that all tests pass. |
There was a problem hiding this comment.
Fix broken internal anchors (#rules, #common-scripts) to satisfy markdownlint.
The links to #rules and #common-scripts don’t resolve (MD051). Easiest fix: remove the fragment links and keep the text.
Apply this diff:
-1. Follow our [Coding Rules](#rules).
-1. Run the full Tinh Tinh test suite (see [common scripts](#common-scripts)),
- and ensure that all tests pass.
+1. Follow our Coding Rules.
+1. Run the full Tinh Tinh test suite and ensure that all tests pass.📝 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.
| 1. Follow our [Coding Rules](#rules). | |
| 1. Run the full Tinh Tinh test suite (see [common scripts](#common-scripts)), | |
| and ensure that all tests pass. | |
| 1. Follow our Coding Rules. | |
| 1. Run the full Tinh Tinh test suite and ensure that all tests pass. |
🧰 Tools
🪛 LanguageTool
[grammar] ~97-~97: There might be a mistake here.
Context: ...ts)), and ensure that all tests pass. 1. Commit your changes using a descriptive ...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
95-95: Link fragments should be valid
(MD051, link-fragments)
96-96: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In CONTRIBUTING.md around lines 95 to 97, the list items use broken internal
anchor links (#rules, #common-scripts) causing markdownlint MD051; remove the
fragment links and replace the linked text with plain text (e.g., "Follow our
Coding Rules." and "Run the full Tinh Tinh test suite (see common scripts), and
ensure that all tests pass.") so the lines no longer contain "#rules" or
"#common-scripts" fragments.
No description provided.