You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Hilbish/CONTRIBUTING.md

2.0 KiB

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.

This file is a document to state the steps/rules to take when making a contribution. Be sure to read through it.

Bug Reports // Feature Requests

Use GitHub Issues to report any bugs or to request any features that may be useful to anyone else.

Check currently open issues and closed ones 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:

  • 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

Making the Pull Request

  1. Ensure that any new install or build dependencies are documented in the README.md and pull request.

  2. Mention any and all changes, feature additons, removals, etc. This includes useful file locations and breaking changes. Document them in the changelog in the pull request.

  3. We use Semver for versioning and Conventional Commits 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.

Finding Issues to Contribute to

You can check out the help wanted labels to figure out what we need your help working on.

The up for grabs labeled issues are low hanging fruit that should be easy for anyone. You can use this to get started on contributing!