From 186d6203111a8d0655bb08281fb62face5138c42 Mon Sep 17 00:00:00 2001 From: TorchedSammy <38820196+TorchedSammy@users.noreply.github.com> Date: Fri, 25 Feb 2022 18:22:59 -0400 Subject: [PATCH] docs: bring contributing guide up to date --- CONTRIBUTING.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a58257e..f841d98 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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!