Community guidelines

Issues and bug reports

In case you encounter issues or bugs, please report them via the GitHub issues. Before creating a new issue, please check whether a certain behavior of the package is already described in its documentation or whether the same problem has already been discussed in an existing GitHub issue.

New issue: To facilitate fixing a problem, a concise report along with a minimal reproducible example (including the error thrown) is most helpful.

Existing issue: Even if a problem has been reported before, it might be very helpful if you add a comment, especially if the details differ somewhat for you. If so, an additional minimal reproducible example is also appreciated.

Feature requests

Feature requests can be raised in the [GitHub issues](https://github.com/retostauffer/python-colorspace/issues as well but be aware that we aim to keep the R version and the Python version of the package in sync.

Pull requests

You are welcome to contribute to Python colorspace via pull requests on GitHub as follows:

  • Create a fork: Start by forking the repository.
  • Create new branch: Create a new branch for your feature request or bug fix. Please make changes against the current main branch.
  • Make changes: Make the required changes and push them to GitHub.
  • Test updated version: If feasible, it is appreciated when the package’s tests are run before proceeding to the next step. The same tests are also run in a GitHub Action after the pull request.
  • Create pull request: Start a pull request on GitHub from your new branch along with a concise description.

Handling of pull requests:

  • Reviewing: Your pull request will be reviewed by the maintainers of the repository. If needed they may ask questions, suggest changes, or reject the pull request if not suitable.
  • Make changes: If changes are requested by the maintainers, please implement them and update your pull request accordingly.
  • Merge: If approved, your changes will be merged into the main branch.