Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(documentation-website):Add npm run local to Contributor Guidelines #737

Merged
merged 7 commits into from
Apr 10, 2024
Merged

docs(documentation-website):Add npm run local to Contributor Guidelines #737

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
41d0ccd
Add npm run local
akhil0203 Apr 8, 2024
585ded4
docs(documentation):add npm run local to contributor guidelines
akhil0203 Apr 8, 2024
f69f3cd
docs(documentation website):Add npm run local to contributor guidelines
akhil0203 Apr 8, 2024
e38fc75
docs(documentation website):Add npm run local to contributor guidelines
akhil0203 Apr 8, 2024
eb0491e
docs(documentation-website):Add npm run local to Contributor Guidelines
akhil0203 Apr 8, 2024
fe8da1f
File filter docs(documentation-website):Add npm run local to Contr…
akhil0203 Apr 8, 2024
f38a198
File filter
akhil0203 Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,15 @@
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.

Check notice on line 118 in CONTRIBUTING.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

CONTRIBUTING.md#L118 

Expected: 80; Actual: 227
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a space after the period for better readability.

- folder.This is particularly
+ folder. This is particularly
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.

Suggested change
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.


```bash
git clone https://github.com/idrinth/api-bench
cd api-bench
npm run local
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt anyone would clone the repo just to get a list of tests, please remove the code here

```

### Naming conventions

Expand Down
Loading