Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

31 lines (24 loc) · 2.41 KB
Raw

Contributing to GroupButler

Contributing to GroupButler isn't limited to just filing bugs, users are more than welcomed to make suggestions, report any issue they may find, and make pull requests to help make GroupButler better.

Working on GroupButler

Prerequisites

Getting GroupButler

  1. Fork a copy of our repo
  2. Open up Git in an environment of your choice
  3. Run the following
$ git clone https://github.com/group-butler/GroupButler.git
$ cd GroupButler

Please pay attention to

  1. Open an issue describing the feature/bug you wish to contribute first to start a discussion, explain why, what and how
  2. Write tests covering 100% of the library code you produce. Don't send PRs which reduce the coverage status
  3. One PR per feature/fix unless you follow standard-version commit guidelines
  4. Naming convention: PascalCase for Classes, camelCase for methods and snake_case for other stuff

Using branches

When working on any issue on Github, it's a good practice to make branches that are specific to the issue you're currently working on. For instance, if you're working on an issue with a name like "NAME OF ISSUE #1234", from the master branch run the following code: git checkout -b Issue#1234. In doing so, you'll be making a branch that specifically identifies the issue at hand, and moves you right into it with the checkout flag. This keeps your main (master) repository clean and your personal workflow cruft out of sight when making a pull request.

Finding issues to fix

After you've forked and cloned our repo, you can find issues to work on by heading over to our issues list. We advise looking at the issues with the labels help wanted or good first issue, as they will help you get familiar with the GroupButler code.

Rules of the discussions

Remember to be very clear and transparent when discussing any issue in the discussions boards. We ask that you keep the language to English and keep on track with the issue at hand. Lastly, please be respectful of our fellow contributors and keep an exemplary level of professionalism at all times.