HigherOrderCO/Bend
1
1
Fork 0
mirror of https://github.com/HigherOrderCO/Bend.git synced 2024-09-11 03:45:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #491 from HigherOrderCO/CONTRIBUTING

Browse Source 
Add CONTRIBUTING
This commit is contained in:
Nicolas Abril 2024-05-28 13:56:09 +00:00 committed by GitHub
commit f72e544da8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,28 @@
# Contributing to Bend
Thank you for considering contributing to Bend!
## How to Contribute
### Reporting bugs
1. **Check for existing issues:** Before you create a new issue, please do a search in [our issues](https://github.com/HigherOrderCO/Bend/issues) to see if the issue or feature request has already been filed.
2. **Create a new issue:** If you find no issue or your issue differs, [create a new issue](https://github.com/HigherOrderCO/Bend/issues/new?template=bug_report.yml) and provide detailed information, including steps to reproduce the problem.
### Suggesting Enhancements
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.
### Checking HVM Issues
Since Bend depends on HVM, some issues might be related 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 formatted and 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!

1
cspell.json
View File

@ -15,6 +15,7 @@
"builtins",
"callcc",
"chumsky",
"clippy",
"codegen",
"codepoint",
"codepoints",