Skip to content

Latest commit

 

History

History
38 lines (33 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

38 lines (33 loc) · 2.07 KB
Raw

Contributing to Clue

Thank you for your interest in contributing to the Clue project! We appreciate contributions via submitting Github issues and/or pull requests.

Below are some guidelines to follow when contributing to this project:

  • Before opening an issue in Github, check open issues and pull requests for existing issues and fixes.
  • If your issue has not been addressed, open a Github issue and follow the checklist presented in the issue description section. A simple code snippet that reproduces your issue helps immensely.
  • If you know how to fix your bug, we highly encourage PR contributions. See How Can I Get Started section on how to submit a PR.
  • For feature requests and submitting major changes, open an issue or hop on to our slack channel (see https://goa.design to join) to discuss the feature first.
  • Keep conversations friendly! Constructive criticism goes a long way.
  • Have fun contributing!

How Can I Get Started?

  1. Go over the package documentation
  2. To get your hands dirty, fork the Clue repo and issue PRs from the fork. PRO Tip: Add a git remote to your forked repo in the Clue source code (in $GOPATH/src/goa.design/clue when installed using go get) to avoid messing with import paths while testing your fix.
  3. Open issues labeled as good first issue are ideal to understand the source code and make minor contributions. Issues labeled help wanted are bugs/features that are not currently being worked on and contributing to them are most welcome.
  4. Link the issue that the PR intends to solve in the PR description. If an issue does not exist, adding a description in the PR that describes the issue and the fix is recommended.
  5. Ensure the CI build passes when you issue a PR to Clue.
  6. Join our slack channel (see https://goa.design to join)!