Hilbish/CONTRIBUTING.md

50 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

2021-04-08 18:47:15 +00:00
# Contributing to Hilbish
Thanks for your interest in contributing to Hilbish! No matter if it's
a new feature, documentation, or bug report, we appreciate any kind
of contributions.
2021-04-08 18:47:15 +00:00
This file is a document to state the steps/rules to take when making
a contribution. Be sure to read through it.
2021-04-08 18:47:15 +00:00
## Bug Reports // Feature Requests
Use GitHub Issues to report any bugs or to request any features
that may be useful to *anyone* else.
2021-10-31 00:03:59 +00:00
Check [currently open issues](https://github.com/Rosettea/Hilbish/issues)
and [closed ones](https://github.com/Rosettea/Hilbish/issues?q=is%3Aissue+is%3Aclosed)
to make sure someone else hasn't already made the issue.
2021-04-08 18:47:15 +00:00
For bug reports, be sure to include:
- Hilbish Version (`hilbish -v`)
- Ways to reproduce
## Code
For any code contributions (Lua and/or Go), you should follow these rules:
2021-04-08 18:47:15 +00:00
- Tab size 4 indentation
- 80 line column limit, unless it breaks code or anything like that
- In Lua prefer no braces `()` if the function takes 1 string argument
- Use camelCase
2021-04-08 18:47:15 +00:00
### Making the Pull Request
1. Ensure that any new install or build dependencies are documented in
the README.md and pull request.
2021-04-08 18:47:15 +00:00
2. Mention any and all changes, feature additons, removals, etc. This includes
useful file locations and breaking changes. Document them in the [changelog](CHANGELOG.md)
in the pull request.
2021-04-08 18:47:15 +00:00
3. We use [Semver](http://semver.org/) for versioning and
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
for commit messages. Please document any breaking changes and be sure to
write proper commits, or your pull request will not be considered.
2021-04-08 18:47:15 +00:00
4. Finally, make the pull request.
2021-04-08 18:47:15 +00:00
## Finding Issues to Contribute to
2021-10-31 00:03:59 +00:00
You can check out the [help wanted](https://github.com/Rosettea/Hilbish/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+)
2021-04-08 18:47:15 +00:00
labels to figure out what we need your help working on.
The [up for grabs](https://github.com/Rosettea/Hilbish/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22+)
labeled issues are low hanging fruit that should be easy for anyone. You can
use this to get started on contributing!