Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 2.99 KB

contributing.md

File metadata and controls

45 lines (27 loc) · 2.99 KB
Raw

Contributing to Homebrewery

How can I contribute?

Improve documentation

As a user of Homebrewery you're the perfect candidate to help us improve our documentation. Typo corrections, error fixes, better explanations, more examples, etc. Open issues for things that could be improved. Anything. Even improvements to this document.

Improve issues

Some issues are created with missing information, not reproducible, or plain invalid. Help make them easier to resolve. Handling issues takes a lot of time that we could rather spend on fixing bugs and adding features.

Write code

You can use issue labels to discover issues you could help out with:

If you're updating dependencies, please make sure you use [email protected] and commit the updated package-lock.json file.

You can also refer to the Development Roadmap on Trello

Submitting an issue

  • The issue tracker is for issues. Use the subreddit for support.
  • Search the issue tracker before opening an issue.
  • Use a clear and descriptive title.
  • Include as much information as possible: Steps to reproduce the issue, error message, browser type and version, etc.

Submitting a pull request

  • Non-trivial changes are often best discussed in an issue first, to prevent you from doing unnecessary work.
  • For ambitious tasks, you should try to get your work in front of the community for feedback as soon as possible. Open a pull request as soon as you have done the minimum needed to demonstrate your idea. At this early stage, don't worry about making things perfect, or 100% complete. Add a [WIP] prefix to the title, and describe what you still need to do. This lets reviewers know not to nit-pick small details or point out improvements you already know you need to make.
  • New features should be accompanied with tests and documentation if applicable.
  • Lint and test before submitting the pull request by running $ npm run verify.
  • If your code is not passing Linting checks due to a non-fixable warning, and you feel it's valid (eg. we lint on a file being too long, but sometimes a file just has to be long), add /* eslint-disable [rule-name] */ to the top of the file. Be sure to justfiy your lint override in your PR description.
  • Use a clear and descriptive title for the pull request and commits.
  • You might be asked to do changes to your pull request. There's never a need to open another pull request. Just update the existing one.