Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

44 lines (33 loc) · 1.98 KB

Contributing to {{{SOLUTION_NAME}}}

Contributions are welcomed and greatly appreciated. We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Proposing new features
  • Discussing the current state of the code
  • Submitting a fix or solutions
  • Becoming a maintainer

We develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We use Github Flow

All code changes happen through Pull Requests.

Pull requests are the best way to propose changes to the codebase (please follow this guid Github Flow).

We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

After creating your first contributing PR you will be requested to sign our Contributor License Agreement by commenting your PR with a special message.

Any contributions you make will be under the {{{SOLUTION_LICENSE}}} License

In short, when you submit code changes, your submissions are understood to be under the same {{{SOLUTION_LICENSE}}} that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue

Write bug reports with detail

This is an template of bug report

Use a Consistent Coding Style

  • 2 spaces for indentation rather than tabs
  • You can try running npm run lint for style unification
  • Add code style files

Links to external documentation, mailing lists, or a code of conduct.

Community and behavioral expectations.