Skip to content

Commit b6c8a0c

Browse files
committed
docs: update contributing
1 parent 647fa89 commit b6c8a0c

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

.github/workflows/ci.yml

+3
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@ jobs:
1818

1919
- name: 📦 Install dependencies
2020
run: bun install
21+
22+
- name: 🧪 Run tests
23+
run: bun run test

README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,24 @@ Before you start, you can use the `./scripts/rename.sh` script to rename all `de
4444
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
4545
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
4646
- Install dependencies using `bun install`
47-
- Run interactive tests using `bun dev`
47+
- Start development server using `bun dev`
48+
- Open [http://localhost:3000](http://localhost:3000) in your browser
49+
50+
## Contributing
51+
To start contributing, you can follow these steps:
52+
53+
1. First raise an issue to discuss the changes you would like to make.
54+
2. Fork the repository.
55+
3. Create a branch with a descriptive name `add-feature` or `fix-issue`.
56+
4. Make changes following the local development steps [above](#local-development).
57+
5. Commit your changes following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
58+
6. Run tests using `bun run test`.
59+
7. Create a pull request following the [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md).
60+
- To be merged, the pull request must pass the tests/workflow and have at least one approval.
61+
- If your changes affect the documentation, make sure to update it.
62+
- If your changes affect the code, make sure to update the tests.
63+
8. Wait for the maintainers to review your pull request.
64+
9. Once approved, the pull request will be merged in the next release !
4865

4966
## License
5067

0 commit comments

Comments
 (0)