Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 3.59 KB

CONTRIBUTING.MD

File metadata and controls

78 lines (51 loc) · 3.59 KB
Raw



Unstated Logo


Contributing to Qore Technologies

First off, thanks for taking the time to contribute!

Contributions are always welcome. Before contributing please read the code of conduct & search the issue tracker your issue may have already been discussed or fixed in master. To contribute, fork QorusToolkit, commit your changes, & send a pull request.

We put together a set of guidelines for contributing to Qore Technologies and it's packages, which are hosted in the Qore Technologies Organization on GitHub. The provided guidelines are not rules but recommendations. Use your best judgement, and feel free to propose changes to this document with a pull request.

We host our open-source on Github

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

We Use Github Flow for code contributions

How to contribute

Pull requests are the best way to propose changes to the codebase (we use Github Flow). 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, 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!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT 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 on github.com/qoretechnologies/qorus-ui/issues it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background of a bug
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • Expected behavior according to your understanding
  • Current behavior which includes the bug
  • Notes (includes, your reasoning behind the problem or steps you tried to solve the bug)

We love thorough bug reports so that we can act fast on them.

Use a Consistent Coding Style

Reference Facebook's Guidelines

  • 2 spaces for indentation rather than tabs
  • 100 character line length
  • Run npm run lint to conform to our lint rules

Community

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Reference Facebook's Guidelines