Skip to content

Commit 24cd750

Browse files
committed
update CONTRIBUTING.md
1 parent d1c7976 commit 24cd750

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

CONTRIBUTING.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,29 @@ git checkout -b my-new-feature
1818

1919
where "my-new-feature" describes what you're working on.
2020

21-
### 3. Add tests for any bug fixes or new functionality
21+
### 3. Setup your environment
22+
23+
This project uses [bun](https://bun.sh/), so you will need to [install it](https://bun.sh/docs/installation) to get started.
24+
Once installed, run `bun install` at the root of the project to install all dependencies.
25+
26+
### 4. Add tests for any bug fixes or new functionality
2227

2328
All functions must be tested with a unit test. Please follow the existing convention of one exported function per file with a corresponding file to test it. Run tests using `bun test`.
2429

25-
### 4. Check code style
30+
### 5. Check code style
2631

2732
Before opening a pull request, ensure that you have installed all dependencies so the pre-commit hooks will run.
2833
These hooks will run ESLint according to the [.eslintrc.json](./.eslintrc.json) and style the code according to the prettier defaults.
2934

30-
### 5. Add documentation for new or updated functionality
35+
### 6. Add documentation for new or updated functionality
3136

3237
Please review all the .md files in this project to see if they are impacted by your change and update them accordingly.
3338

34-
### 6. Format Commits
39+
### 7. Format Commits
3540

3641
This project uses [Semantic Release](https://github.com/semantic-release/semantic-release) for versioning. As such, commits need to follow the format: `<type>(<scope>): <short summary>`. All fields are required.
3742

38-
### 7. Submit Pull Request and describe the change
43+
### 8. Submit Pull Request and describe the change
3944

4045
Push your changes to your branch and open a pull request against the parent repo on GitHub. The project administrators will review your pull request and respond with feedback.
4146

0 commit comments

Comments
 (0)