sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity

docs: bring contributing guide up to date

windows-fixes
TorchedSammy 2022-02-25 18:22:59 -04:00
parent 15cf5bb6f3
commit 186d620311
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
CONTRIBUTING.md
View File

@ -11,37 +11,38 @@ Use GitHub Issues to report any bugs or to request any features
that may be useful to *anyone* else.
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.
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.
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:
For any code contributions (Lua and/or Go), you should follow these rules:
- Tab size 4 indentation
- In Lua prefer no braces `()` if the function takes 1 argument
- Use camelCase for function names
- 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
### Making the Pull Request
1. Ensure that any new install or build dependencies are documented in
the README.md and PR request.
the README.md and pull request.
2. Say in the pull request details the changes to the shell,
this includes useful file locations and breaking changes.
2. Mention any and all changes, this includes useful file locations and
breaking changes.
3. We use [SemVer](http://semver.org/) for versioning and
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 backwards incompatible changes and be sure to name
your commits correctly.
for commit messages. Please document any breaking changes and be sure to
write proper commits, or your pull request will not be considered.
4. Finally, make the pull request to the **dev** branch.
4. Finally, make the pull request.
## Finding Issues to Contribute to
You can check out the [help wanted](https://github.com/Rosettea/Hilbish/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+)
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!
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!