Contributing Guidelines

August 10, 2026 · View on GitHub

Thank you for contributing to a Schmiedmayer Lab project. We value the time and effort you invest in open-source research software.

We use GitHub Discussions at https://github.com/orgs/SchmiedmayerLab/discussions for project discussions. Please follow our Code of Conduct.

We use the GitHub Flow for all code-related contributions. GitHub Discussions are the best way to brainstorm your suggestions. GitHub issues are the best way to document decisions or bugs. Pull requests are the best way to propose changes to the codebase.

Licensing

Your submissions must be published and conform to the license currently used in the respective repository.

Attributions

We use the REUSE Software Conventions to structure our attributions and contributor lists.

Each file must contain the following header information, with Schmiedmayer Lab replaced by the project name.

This source file is part of the Schmiedmayer Lab open-source organization

SPDX-FileCopyrightText: 2026 Schmiedmayer Lab and the project authors (see CONTRIBUTORS.md)

SPDX-License-Identifier: MIT

As referenced in the copyright text, we list all contributors in the CONTRIBUTORS.md file at the root of every repository. Contributors can add themselves to CONTRIBUTORS.md in a pull request with a sizable and meaningful contribution to the project.

If your code is based on another source, you must add a reference to the original source in the relevant code (e.g., using a comment) and make sure that the original source license allows usage under the license used in the project.

Contributing Guidelines

Licensing

Attributions

Data in Contributions

Bug Reporting

Support Policy

Security Policy