Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

49 lines (36 loc) · 1.92 KB
Raw

Contributing

We want to make contributing to this project as easy and transparent as possible.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the maintainers of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Our Development Process

We love and follow GitHub flow, read the Gitflow guidlines here

We use GitHub to sync code to and from our internal repository. We'll use GitHub to track issues and feature requests, as well as accept pull requests.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from develop.
  2. If you've added code that should be tested.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Great Bug Reports tend to have:

  • A quick description
  • Steps to reproduce the bug
    • Be specific.
    • Give sample code if you can.
  • What you expected would happen.
  • What actually happens.
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People ❤️ thorough bug reports.

Report a bug by opening a new issue; it's that easy!

Coding Style

  • 2 spaces for indentation rather than tabs
  • 80 character line length
  • Run npm run lint to conform to our lint rules
  • Additionally you can also run npm run pretty to prettify the code

License

By contributing to automata, you agree that your contributions will be licensed under its MIT license.