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 14:28:56 +00:00
|
|
|
|
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 14:28:56 +00:00
|
|
|
|
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)
|
2022-02-25 22:22:59 +00:00
|
|
|
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
|
2022-02-25 22:22:59 +00:00
|
|
|
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
|
2022-02-25 22:22:59 +00:00
|
|
|
- 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
|
2022-02-25 22:22:59 +00:00
|
|
|
the README.md and pull request.
|
2021-04-08 18:47:15 +00:00
|
|
|
|
2022-05-30 22:16:36 +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
|
|
|
|
2022-02-25 22:22:59 +00:00
|
|
|
3. We use [Semver](http://semver.org/) for versioning and
|
2021-12-09 03:04:30 +00:00
|
|
|
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
|
2022-02-25 22:22:59 +00:00
|
|
|
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
|
|
|
|
2022-02-25 22:22:59 +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.
|
|
|
|
|
|
2022-02-25 22:22:59 +00:00
|
|
|
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!
|
