docs(documentation-website):Add npm run local to Contributor Guidelines #737
Conversation
add npm run local to contributor guidelines
WalkthroughWalkthroughThe integration has progressed with the addition of Changes
Assessment against linked issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
github-actions
bot
added
the
documentation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Thank you for contributing!
Please make sure the actions pass. Once your pull request has been merged, you will automatically be added to the contributor's list on the website.
If you want to be shouted out on Linkedin, have a look for the shoutout issue of the specific version.
You can also find us on slack at idrinth-api-bench.
![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
Review Status
Configuration used: .coderabbit.yaml
Files selected for processing (1)
- CONTRIBUTING.md (1 hunks)
Additional Context Used
GitHub Check Runs (1)
Codacy Static Code Analysis action_required (1)
CONTRIBUTING.md: [notice] 118-118: CONTRIBUTING.md#L118
Expected: 80; Actual: 227
Additional comments not posted (1)
CONTRIBUTING.md (1)
116-124: Ensure clarity in instructions for running tests locally.CodeRabbit suggests adding a brief explanation on how
npm run localworks and what CI tasks it covers. This will provide contributors with a better understanding of what to expect when they run this command.
There was a problem hiding this comment.
Actionable comments posted: 1
Review Status
Configuration used: .coderabbit.yaml
Files selected for processing (1)
- CONTRIBUTING.md (1 hunks)
Additional Context Used
GitHub Check Runs (1)
Codacy Static Code Analysis action_required (1)
CONTRIBUTING.md: [notice] 119-119: CONTRIBUTING.md#L119
Expected: 80; Actual: 227
Additional comments not posted (1)
CONTRIBUTING.md (1)
117-125: Instructions for running tests locally are clear and fulfill the PR objectives.
CONTRIBUTING.md
Outdated
| @@ -114,6 +114,16 @@ | |||
| npm run coai | |||
| ``` | |||
|
|
|||
| #### Running Tests Locally | |||
|
|
|||
| To see a list of available CI tasks and their corresponding commands to run them locally you can run `npm run local` in the source folder.This is particularly useful for testing specific CI tasks before committing your changes. | |||
There was a problem hiding this comment.
Add a space after the period for better readability.
- folder.This is particularly
+ folder. This is particularlyCommittable 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.
| To see a list of available CI tasks and their corresponding commands to run them locally you can run `npm run local` in the source folder.This is particularly useful for testing specific CI tasks before committing your changes. | |
| To see a list of available CI tasks and their corresponding commands to run them locally you can run `npm run local` in the source folder. This is particularly useful for testing specific CI tasks before committing your changes. |
|
@akhil0203 thank you for helping! Do you want to add the website changes as well? If not I'll merge the doc changes. Files: |
CONTRIBUTING.md
Outdated
| @@ -114,6 +114,16 @@ cd api-bench | |||
| npm run coai | |||
| ``` | |||
|
|
|||
| #### Running Tests Locally | |||
|
|
|||
| To see a list of available CI tasks and their corresponding commands to run them locally, you can run `npm run local` in the source folder. This is particularly useful for testing specific CI tasks before committing your changes. | |||
There was a problem hiding this comment.
we usually add a line break after 80 characters to make it unnecessary to scroll
CONTRIBUTING.md
Outdated
| ```bash | ||
| git clone https://github.com/idrinth/api-bench | ||
| cd api-bench | ||
| npm run local |
There was a problem hiding this comment.
I doubt anyone would clone the repo just to get a list of tests, please remove the code here
There was a problem hiding this comment.
Actionable comments posted: 1
Review Status
Configuration used: .coderabbit.yaml
Files selected for processing (1)
- CONTRIBUTING.md (1 hunks)
Additional comments not posted (1)
CONTRIBUTING.md (1)
117-121: Ensure line breaks after 80 characters to avoid the necessity to scroll.
docs(documentation-website):Add npm run local to Contributor Guidelines
|
i would love to do it ,as this is my first contribution to this awesome project i may take some time to sort it out but i will complete the task |
thanks, if you need any help, just ask - you can find at least me on our slack :) There is a guide to the language files on our youtube, that may actually help a bit: https://www.youtube.com/watch?v=FEYIeMCrrbk |
|
@akhil0203 will merge the current change already, so we have you among the contributors already :) not taking the task away from you, just create a fresh branch for it please! |
The Pull Request is ready
Overview
This pull request addresses the issue by updating the contributor guidelines to include instructions for running Continuous Integration (CI) tasks locally using the npm run local command.
Documentation-Website