Skip to content

Commit aeea92a

Browse files
docs: update contributing guidelines to include build step and prerequisites (#648)
1 parent e603b34 commit aeea92a

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,19 @@ We welcome contributions to Samui Wallet. Please follow these guidelines to ensu
1111
```
1212
3. **Make Changes:** Write your code. Ensure it adheres to the existing code style.
1313
4. **Test Your Changes:** Run any existing tests and add new tests for your changes.
14-
5. **Commit:** Write a clear and concise commit message using conventional commits.
14+
5. **Build Your Changes:** Make sure your changes build without errors.
15+
```bash
16+
bun run build
17+
```
18+
6. **Commit:** Write a clear and concise commit message using conventional commits.
1519
```bash
1620
git commit -m "feat: Add new feature"
1721
```
18-
6. **Push:** Push your branch to your fork.
22+
7. **Push:** Push your branch to your fork.
1923
```bash
2024
git push origin <your-github-username>/your-feature-name
2125
```
22-
7. **Open a Pull Request (PR):** Open a PR from your branch to the `main` branch of the original repository. Provide a clear description of your changes.
26+
8. **Open a Pull Request (PR):** Open a PR from your branch to the `main` branch of the original repository. Provide a clear description of your changes.
2327

2428
### Keep Pull Requests Small and Focused
2529

@@ -29,6 +33,21 @@ Try to break down large features into smaller, incremental changes. Each PR shou
2933

3034
Avoid including unrelated changes. If you notice something that needs fixing but is outside the scope of your current work, create a separate [issue](https://github.com/samui-build/samui-wallet/issues/new/choose) or address it in a follow-up PR. This helps keep your PRs focused and easy to review.
3135

36+
## Prerequisites
37+
38+
Before you start contributing, please make sure you have the following with the correct versions:
39+
40+
- [Node.js](https://nodejs.org)
41+
- [Bun](https://bun.sh)
42+
43+
- The project requires the correct Bun version, as specified in [`package.json`](./package.json) or .bun-version.
44+
45+
We use [Biome](https://biomejs.dev/) for code formatting and linting. To ensure consistency:
46+
47+
- Disable any other code formatters (such as ESLint, Prettier, etc.).
48+
- Configure your editor to use Biome for formatting and linting on save.
49+
- See your editor's documentation for how to set Biome as the default formatter.
50+
3251
## Keeping Your Branch Updated
3352
3453
As you work, the `main` branch may be updated with other changes. It's important to keep your branch up-to-date to avoid merge conflicts and maintain a clean commit history.

0 commit comments

Comments
 (0)