Thank you for contributing to the Stanford Spezi open-source project! We value the time and effort you invest in the open-source project!
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
You MUST follow our Code of Conduct.
We REQUIRED using the Github Flow for all code-related contributions. GitHub discussions SHALL be the best way to brainstorm your suggestions. GitHub issues SHALL be the best way to document decisions or bugs. Pull requests SHALL be the best way to propose changes to the codebase.
Every new contribution MUST be properly tested and automatically verified our continuous integration setup using GitHub Actions.
Your submissions MUST be published and conform to the license currently used in the respective repository.
Each file MUST contain the header information with the SimVascular license.
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 work items. Report a bug SHALL be done by opening a new issue using the bug issue template.
These Contributing Guidelines are inspired by StanfordSpezi's