Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (50 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

76 lines (50 loc) · 3.38 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 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 integration drivers 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 repo.

  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 the Mozilla Public License 2.0, or a compatible license, if existing parts of other projects are reused (e.g. MIT licensed code).
    It is required to add a boilerplate copyright notice to the top of each file:

    """
{fileheader}

:copyright: (c) {year} {person OR org} <{email}>
:license: MPL-2.0, see LICENSE for more details.
"""

  3. Make sure your changes follow the project's code style and the lints pass described in Code Style.

  4. Push to your fork.
    Do not include any project configuration changes in the .idea folder! If you are also using an IntelliJ product, chances are that you're using a different IDE, version or other settings, which can cause issues. For example, between IntelliJ Ultimate and PyCharm.

  5. 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, otherwise the pull request will not be merged.

Feedback 💬

There are a few different ways to provide feedback: