Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.31 KB

contributing.md

File metadata and controls

29 lines (18 loc) · 1.31 KB

Contributing

New contributions to the application are welcome, but we ask that you please follow these guidelines:

  • Study the project wiki thoroughly and see PR guideline and convention.
  • Check that your code will pass eslint code standards, hound will review your code and ensure you act accordingly.
  • Check that your code will pass tests, backend: npm test and frontend: client-test will run tests for you.
  • Keep pull requests concise, and document new functionality in PRs.
  • Avoid breaking changes unless they are very essential. We encourage people to care a lot about backwards compatibility.

Joining the project

Active committers and contributors are invited. If you think you can help, we'd love to have you!

Bugs and Issues

Please report by creating an Issue for feature and support requests. Well structured, detailed bug reports are hugely valuable for the project.

Guidelines for reporting bugs:

  • Check the issue search to see if it has already been reported
  • Isolate the problem to a simple test case
  • Please include a demonstration of the bug on a website such as JS Bin, JS Fiddle, or Codepen.

Please provide any additional details associated with the bug.