Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

23 lines (17 loc) · 1.5 KB
Raw

Contributing to Stretchly

Have you read Code of Conduct? When contributing, you are expected to comply with it, including treating everyone with respect: https://github.com/hovancik/stretchly/blob/master/CODE_OF_CONDUCT.md

Pull Requests

PRs are welcome, but before implementing a feature, please, open an Issue first, so we can be sure that no one else is working on it and that the changes will be accepted. It is important do discuss changes before implementing them (Why should we add it? How should it work? How should it look? Where will it be? ...). Failing to do so might get your PR closed.

Once you are sure that the maintainer of Stretchly will accept your proposed changes, feel free to open PR once you start working on it, so anyone can review and comment on your code.

Other things to keep in mind:

  • use node version from package.json
  • write tests if possible
  • add yourself to README
  • add your changes to CHANGELOG
  • tick a checkbox when adding something from TODOs
  • do not edit version number
  • keep the code style
  • edit screenshots in README if needed
  • be nice and have fun ;]

When you are ready with your code, make sure to follow steps in PULL_REQUEST_TEMPLATE.

Thanks for your interest in making Stretchly better!