HigherOrderCO/Bend
1
1
Fork 0
mirror of https://github.com/HigherOrderCO/Bend.git synced 2024-08-16 07:10:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add submitting changes and HVM issue headers

Browse Source
This commit is contained in:
kings177 2024-05-27 16:35:02 -03:00
parent 59f9b6fa25
commit 2bd0768e89
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -10,4 +10,19 @@ Thank you for considering contributing to Bend!
1. **Check for existing suggestions:** Before suggesting a new feature, please check if it's already been suggested in [our issues](https://github.com/HigherOrderCO/Bend/issues).
2. **Create a new suggestion:** If you find no similar suggestion, [create a new suggestion issue](https://github.com/HigherOrderCO/Bend/issues/new?template=feature_request.md) and provide detailed information about the enhancement and why it would be useful.
TODO
### Checking HVM Issues
Since Bend depends on HVM, some issues might be relateds to HVM rather than Bend itself. Please also check the [HVM issues page](https://github.com/HigherOrderCO/HVM/issues) to see if your issue has already been reported there.
### Submitting Changes
1. **Fork the repository:** Create your own fork of the repository on GitHub.
2. **Create a new branch:** Make your changes in a new branch in your forked repository.
3. **Run formatting and linting checks:** Before submitting your changes, ensure your code is properly formated asnd linted:
- Run `cargo fmt` to format your code.
- Run `cargo clippy` to lint your code.
4. **Run tests:** Ensure all tests pass and update any test results:
- Run `cargo insta test` to run the tests.
- Run `cargo insta review` to save any changes to the test results.
5. **Submit a pull request:** Once your changes are ready, submit a pull request from your branch to the `main` branch of the Bend Repository
We appreciate every contribution!