Contributing Guidelines

August 31, 2017 · View on GitHub

Contributions are always welcome; however, please read this document in its entirety before submitting a Pull Request or Reporting a bug.

Table of Contents

Reporting a Bug

Think you've found a bug? Let us know!

Creating an Issue

Your issue must follow these guidelines for it to be considered:

Before submitting

  • Check you’re on the latest version, we may have already fixed your bug!
  • Search our issue tracker for your problem, someone may have already reported it

Things to include

  • Clear, reproducible steps to encounter the bug
  • Current system information

Labels

  • Apply the bug label
  • Apply (to the best of your ability) the appropriate component/ label
    • If you are uncertain simply use component/cli

Feature Requests

Manifold CLI is ever-evolving, and that's thanks to user feedback. If you have an idea for a feature, let us know!

Things to include

  • How the tool operates today.
  • Why current functionality is problematic.
  • Use cases for the new functionality
  • A detailed proposal (or pull request) that demonstrates how you feel the problem could be solved.

Labels

  • Apply the discussion/feature label
  • Apply (to the best of your ability) the appropriate component/ label
    • If you are uncertain simply use component/cli

Opening a Pull Request

To contribute, fork manifold-cli, commit your changes, and open a pull request.

Your request will be reviewed once the appropriate labels have been added. You may be asked to make changes to your submission during the review process.

Before submitting

  • Run the tests using make test
  • Review the manual QA guide (until our test coverage improves)
  • Test your change thoroughly

Body

  • Supply examples of command behaviour (command output, daemon logs, etc)
  • Explain why your particular changes were made the way they are
  • Reference the issue your request closes in the body of the PR with Closes #

Labels

  • Apply the meta/in-review label once your code is ready for review
  • If you are opening before it is finished, please use meta/in-progress
  • Apply (to the best of your ability) the appropriate component/ label
    • If you are uncertain simply use component/cli

Code Guidelines

Go uses gofmt to automatically format your code, it's best to integrate this into your editor.

Check your code's formatting using make fmtcheck.

Code of Conduct

All community members are expected to adhere to our code of conduct.

License

Manifold's manifold-cli is released under the BSD 3-Clause License.

Contributor license agreement

For legal purposes all contributors must sign a contributor license agreement, either for an individual or corporation, before a pull request can be accepted.

You will be prompted to sign the agreement by CLA Assistant (bot) when you open a Pull Request for the first time.