Thank you for contributing to one of the Stanford Biodesign Digital Health Group projects! We value the time and effort you invest in the open-source project!
We use GitHub Discussions at https://github.com/orgs/StanfordBDHG/discussions for any discussions about the project. 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.
Your submissions must be published and conform to the license currently used in the respective repository.
We use the REUSE Software Conventions to structure our attributions and contributor lists.
Each file must contain the following header information with Stanford being replaced with the project name and MIT with the SPDX License Identifier.
This source file is part of the Stanford open-source project
SPDX-FileCopyrightText: 2022 Stanford University 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 at the root of every repository. Each contributor can add themselves to the 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 code to the specific code (e.g., using a comment) and make sure that the license of the original source allows the usage under the license used in the project.
We use GitHub issues to track public bugs. Report a bug by opening a new issue using the bug issue template.
Please refer to our Support Policy for information about getting support.
For security and vulnerability-related issues, please refer to our Support Policy.