You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
where "my-new-feature" describes what you're working on.
20
20
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
22
27
23
28
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`.
24
29
25
-
### 4. Check code style
30
+
### 5. Check code style
26
31
27
32
Before opening a pull request, ensure that you have installed all dependencies so the pre-commit hooks will run.
28
33
These hooks will run ESLint according to the [.eslintrc.json](./.eslintrc.json) and style the code according to the prettier defaults.
29
34
30
-
### 5. Add documentation for new or updated functionality
35
+
### 6. Add documentation for new or updated functionality
31
36
32
37
Please review all the .md files in this project to see if they are impacted by your change and update them accordingly.
33
38
34
-
### 6. Format Commits
39
+
### 7. Format Commits
35
40
36
41
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.
37
42
38
-
### 7. Submit Pull Request and describe the change
43
+
### 8. Submit Pull Request and describe the change
39
44
40
45
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.
0 commit comments