Skip to content

Commit 5f7ff3b

Browse files
committed
docs: add contributing guidelines (#117)
1 parent dd0d2e7 commit 5f7ff3b

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing to Fusion
2+
3+
Thank you for investing your time in contributing to our project!
4+
5+
Before you start contributing, please take a moment to read through these guidelines. They will help you understand how to contribute effectively and make the process smoother for everyone involved.
6+
7+
## Issues
8+
9+
- Please search for existing issues before creating a new one. If you find an existing issue that matches your concern, please add your comments there instead of creating a new issue.
10+
- If you are reporting a bug, please provide as much detail as possible, including steps to reproduce the issue, expected behavior, and actual behavior. Screenshots or logs are very helpful.
11+
- If you are suggesting a new feature or improvement, please explain the use case and how it would benefit the project. A clear description helps us understand your perspective better.
12+
- If you are unsure whether your issue is a bug or a feature request, feel free to ask in the issue comments. We are here to help!
13+
14+
## Pull requests
15+
16+
- Please ensure your PR is clear and concise. One PR should ideally address one issue or feature request at a time.
17+
- A good PR description should include:
18+
- A brief summary of the changes you made.
19+
- The reason for these changes and any relevant context.
20+
- Any related issues or discussions (link to them if possible).
21+
- Make sure your code follows the project's coding style and conventions. You can run the linter and formatter to check for any issues before submitting your PR.
22+
- Set the status to Draft if your PR is still a work in progress. This helps us understand that you are not yet ready for a review.
23+
- AI coding is cool, but please carefully review the code before submitting a PR, rather than just relying on 'vibe coding'.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Maintained by community:
6161

6262
### Build from source
6363

64-
Check out the Development section.
64+
Check out the "Contributing" section.
6565

6666
## Configuration
6767

@@ -72,7 +72,9 @@ Fusion can be configured in many ways:
7272
- System environment variables, such as those set by `export PASSWORD=123abc`.
7373
- Create a `.env` file in the same directory as the binary. Note that values in `.env` file can be overwritten by system environment variables.
7474

75-
## Development
75+
## Contributing
76+
77+
Contributions are welcome! Before contributing, please read the [Contributing Guidelines](./CONTRIBUTING.md).
7678

7779
- Prepare environment: Go 1.24+, Node.js 23+ (and pnpm).
7880
- Check out the commands in `scripts.sh`.

0 commit comments

Comments
 (0)