We adhere to the Contributor Covenant Code of Conduct found below.
- avoid pushing new features directly (also consider no upstream pushing)
- fork to your private github
- create a new branch with a name meaningful for the feature at hand
- create a Draft Pull Request with
WIP:in its name to themasterbranch (example:WIP: documentation updates) - commit all your work to your new branch; other developers can provided feedback by reviewing your pull request
- when the feature is ready: remove the
WIP:and set it ready to review - when your changes get approved, remember to always select Squash and merge from the drop-down button
New features are merged when CI is passing and two other members approve your pull request.
For GitHub Actions, the CI needs to pull and push docker images to a repository. Using docker hub is advised. New registries will be created and images will be pushed and pulled during builds. Have a look at docker-compose-build.yml for a full list of names. To avoid collisions make sure the names of the services are not used by your other projects.
To enable GitHub Actions on your forked repository:
- go to the
Actionspage and enable them - go to the repo's
Settingspage and the click onSecrets - you have to add the following:
DOCKER_USERNAMEdocker hub usernameDOCKER_REGISTRYdocker hub usernameDOCKER_PASSWORDdocker hub access token (avoid using your password)
Current setup: ESLint for JavaScript and Black + Pylint for Python. Have a look in the project root for individual configuration files.
Read more at Coding Conventions and Linters.
Q: I have strange database errors, but I did not change anything. What could I try?
A: After starting the application, apply Postgres migrations, run make help in project root for details.
Q: I am new to the project, how do I view all available commands?
A: Run make help in the directory containing a Makefile. Usage will be shown. Don't be afraid to read the file, it is quite strait forward and well documented.
Q: My pull request's CI is failing to push/pull images from Docker Hub? A: Check your settings again, see CI-notes and retry.
Q: It is not clear how dependencies work. Where can I read more? A: Management of python dependencies has a detailed explanation and useful resources.
Q: I see and api folder full of text files, what is it?
A: Look at APIs development guidelines it will point you in the right direction.
Q: Do you need to commit something (maybe work in progress) and it makes no sense to have the CI run it?
A: Add [ci skip] in any part of your commit message. The CI will not run get started.
Q: I don't have a good understanding of the aims of the project. Where can I read more? A: D1.1 Technical Specs. & Technology Evaluation is extensive, but explains the decision making behind most of the code. Please consider reading it. Afterwords you can better grasp the Computational backend description.
Q: Can I have some sort of introduction video about the project? A: Have a look at the following videos, targeted for wider audiences: What is the SPARC program?, Ideas Lab Introduction to o²S²PARC and SPARC Webinar: Introduction to o²S²PARC
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected]. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.