Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 2.8 KB

Contributing

First off, thanks for taking the time to contribute!

Found a bug, typo, missing feature or a description that doesn't make sense or needs clarification?
Great, please let us know!

Bug Reports 🐛

If you find a bug, please search for it first in the GitHub issues, and if it isn't already tracked, create a new issue.

New Features 💡

If you'd like to see or add new functionality to the library, describe the problem you want to solve in a new Issue.

Pull Requests

Any pull request needs to be reviewed and approved by the Unfolded Circle development team.

We love contributions from everyone.

⚠️ If you plan to make substantial changes, we kindly ask you, that you please reach out to us first.
Either by opening a feature request describing your proposed changes before submitting code, or by contacting us on one of the other feedback channels.

Since this library is being used in an integration driver running on the embedded UC Remote devices, we have to make sure it remains compatible with the embedded runtime environment and runs smoothly.

Submitting pull requests for typos, formatting issues etc. are happily accepted and usually approved relatively quick.

With that out of the way, here's the process of creating a pull request and making sure it passes the automated tests:

Contributing Code 💡

  1. Fork the repository.

  2. Make your changes or enhancements.
    This should be done in a dedicated branch and not on the main branch to easily submit individual pull requests.

    Contributed code must be licensed under MIT License.

  3. Make sure your changes pass the unit tests and tests are added for new or changed functionality:

    npm run test

  4. Make sure your changes follow the configured prettier code style:

    npm run format

  5. Make sure your changes make the lints pass:

    npm run lint

  6. Push to your fork.

  7. Submit a pull request.

At this point we will review the PR and give constructive feedback.
This is a time for discussion and improvements, and making the necessary changes will be required before we can merge the contribution. Furthermore, all the automated checks must pass.

Feedback 💬

There are a few different ways to provide feedback: