mirror of
https://github.com/0x2E/fusion.git
synced 2025-06-07 21:17:07 +09:00
docs: add contributing guidelines (#117)
This commit is contained in:
parent
dd0d2e7d7d
commit
5f7ff3b8af
2 changed files with 27 additions and 2 deletions
23
CONTRIBUTING.md
Normal file
23
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
# Contributing to Fusion
|
||||
|
||||
Thank you for investing your time in contributing to our project!
|
||||
|
||||
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.
|
||||
|
||||
## Issues
|
||||
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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!
|
||||
|
||||
## Pull requests
|
||||
|
||||
- Please ensure your PR is clear and concise. One PR should ideally address one issue or feature request at a time.
|
||||
- A good PR description should include:
|
||||
- A brief summary of the changes you made.
|
||||
- The reason for these changes and any relevant context.
|
||||
- Any related issues or discussions (link to them if possible).
|
||||
- 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.
|
||||
- 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.
|
||||
- AI coding is cool, but please carefully review the code before submitting a PR, rather than just relying on 'vibe coding'.
|
|
@ -61,7 +61,7 @@ Maintained by community:
|
|||
|
||||
### Build from source
|
||||
|
||||
Check out the Development section.
|
||||
Check out the "Contributing" section.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
@ -72,7 +72,9 @@ Fusion can be configured in many ways:
|
|||
- System environment variables, such as those set by `export PASSWORD=123abc`.
|
||||
- Create a `.env` file in the same directory as the binary. Note that values in `.env` file can be overwritten by system environment variables.
|
||||
|
||||
## Development
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Before contributing, please read the [Contributing Guidelines](./CONTRIBUTING.md).
|
||||
|
||||
- Prepare environment: Go 1.24+, Node.js 23+ (and pnpm).
|
||||
- Check out the commands in `scripts.sh`.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue