Skip to content

Commit

Permalink
Update CONTRIBUTING.md and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jagoda11 committed Mar 29, 2024
1 parent d5360b8 commit 47d0d5e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,12 @@ We also welcome PRs. For larger PRs, we advise opening an issue first to discuss

1. [Fork][fork] and clone the repository.
2. Configure and install the dependencies: `npm install`.
3. Make sure the tests pass on your machine: `npm test`. Note: these tests also apply the linter, so there's no need to lint separately.
4. Create a new branch: `git checkout -b my-branch-name`.
5. Make your change, add tests, and ensure the tests still pass.
6. Push to your fork and [submit a pull request][pr].
7. Give yourself a pat on the back 👏 and wait for your pull request to be reviewed and merged.
3. Make sure the tests pass on your machine: `npm test`. Note: these tests also apply the linter, so there's no need to lint separately. We've set up a pre-commit hook with Husky, so tests will automatically run before each commit.
4. Format your code: `npm run format`.
5. Create a new branch: `git checkout -b my-branch-name`.
6. Make your change, add tests, and ensure the tests still pass.
7. Push to your fork and [submit a pull request][pr].
8. Give yourself a pat on the back 👏 and wait for your pull request to be reviewed and merged.

Here are a few things that will increase the likelihood of your pull request being accepted:

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ These instructions will get you a copy of the project up and running on your loc
```bash
npm run clean
```

8. **Format the code**

```bash
Expand All @@ -64,6 +64,7 @@ These instructions will get you a copy of the project up and running on your loc
npm run precommit
```

Note: We've set up a pre-commit hook with Husky 🐶, so this script will automatically run before each commit.
## 🐳 Docker
Expand Down

0 comments on commit 47d0d5e

Please sign in to comment.