Contributing to EMPIARreader#

Thank you for taking the time to contribute to EMPIARReader!

Contents:

  • how-to-contribute

  • 🖊️ License

How to contribute to EMPIARReader

—

Bug reports:

First, please check the open issues in case the bug has already been reported.

If not, then open a new issue here.

Code and documentation contributions:

Additional features, code quality improvements, issues, typos, documentation improvements are all welcome.

To get started:
  • Consider starting a discussion, to get feedback on your idea, or participating in an ongoing one

  • Look for any relevant issues.

Pull requests are welcome: see how-to-contribute which describes our workflow.

How to contribute changes to this repository —

  • Open a Pull Request.

  • Our basic workflow is GitHub flow. In particular: - The branch main always contain the latest working version of the package. - Pull Requests should normally have main as their base branch (this is the default). - A Pull Request doesn’t have to represent finished work. Pull Requests are welcome at an early stage of work on a contribution, so others can watch or give feedback, or as a place to discuss the work in progress—you can always add more commits to the same branch later, and they will be included too. If it is not ready to merge, include “WIP” (Work in Progress) in the subject line, or select “Create Draft Pull Request” when opening it. - For a Pull Request to be ready to merge:

    • All of the automated tests should pass

    • It should add tests of any new functionality

    • A code review can be requested at any time

    • Pull requests are squash merged to main