Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 1.48 KB

Contributing

Thanks for your interest in contributing! Please see the Developer Guide in our Resonate Handbook for a clear overview of all things development related.

There are many ways to contribute:

Guidelines

  1. Fork the project and clone locally. See README
  2. Create a branch
  3. Code and commit your changes. Good commit messages are always appreciated!
  4. Push to the branch
  5. Create a pull request for your branch

Creating issues

When filing an issue, make sure to follow this template:

  • Operating system
  • Browser name and version
  • Steps to reproduce
  • Expected behavior
  • Actual behavior

Testing

Tests are required for contributions. Please refer to "Testing" section in README to write and run tests.

Creating a pull request

  • Keep the pull requests concise
  • Make sure all tests pass
  • Document your code with comments and update existing documentation if needed
  • Refer issue related to the pull request if it exists

Further help

Create an issue and mention the author @auggod