diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..e1094af --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +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. + +## Our Standards + +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 + +## Enforcement Responsibilities + +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. + +## Scope + +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. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +sochat1@llnl.gov. +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. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**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. + +### 2. Warning + +**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. + +### 3. Temporary 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. + +### 4. 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. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +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](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +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. diff --git a/.github/GOVERNANCE.md b/.github/GOVERNANCE.md new file mode 100644 index 0000000..452c86a --- /dev/null +++ b/.github/GOVERNANCE.md @@ -0,0 +1,67 @@ +# Project Governance + +This repository (the `flux-restful-api`) is a component of the **Flux Framework ecosystem**. + +While this project operates under the high-level guidance of the [Flux Framework Project](https://flux-framework.readthedocs.io/projects/flux-core/en/latest/guide/support.html), it maintains its own list of maintainers, release cadence, and technical decision-making processes tailored to the specific language and domain (e.g., Python, Go/Kubernetes, REST APIs) of the component. + +## 1. Roles and Responsibilities + +### 1.1 Contributors + +Contributors are community members who submit patches, file issues, improve documentation, or answer questions on community channels. Anyone can be a contributor. There is no expectation of long-term commitment. + +### 1.2 Maintainers +Maintainers are contributors who have shown dedication to the project through consistent, high-quality contributions. Maintainers have **Write Access** to the repository. + +**Responsibilities:** +* Reviewing and merging Pull Requests (PRs). +* Triaging and managing Issues. +* Cutting releases and publishing artifacts (e.g., to PyPI, Docker Hub, or GitHub Releases). +* Ensuring code quality, test coverage, and security standards are met. +* Participating in technical discussions and design reviews. + +**Becoming a Maintainer:** +Maintainership is earned by merit. Existing maintainers may nominate a contributor who has demonstrated: + +1. A solid understanding of the project's codebase and goals. +2. A history of high-quality pull requests. +3. A collaborative and respectful attitude toward other community members. +4. Commitment to the project's [Code of Conduct](CODE_OF_CONDUCT.md). + +New maintainers are added by a consensus vote of the existing maintainers. + +## 2. Decision Making + +### 2.1 Lazy Consensus +To ensure velocity, this project operates primarily on **Lazy Consensus**. +* Changes are proposed via Pull Requests or Issues. +* If a Maintainer reviews and approves the change, and no other Maintainer objects within a reasonable timeframe (usually 48 hours for non-trivial changes), the change is accepted. +* Silence is not interpreted as consent. + +### 2.2 Voting +In the rare event that consensus cannot be reached: +1. Maintainers will attempt to resolve the disagreement through discussion on GitHub or the developer meeting. +2. If a deadlock persists, a simple majority vote of the current Maintainers of this repository decides the outcome. +3. In the event of a tie, the issue is escalated to the Flux Framework developers. + +## 3. Contribution Process + +### 3.1 Developer Certificate of Origin (DCO) + +To ensure the project can legally redistribute your contributions, all commits must be signed off. This certifies that you wrote the code or have the right to contribute it. +* Git command: `git commit -s ...` +* This adds a `Signed-off-by: Name ` trailer to your commit message. + +### 3.2 Code Review +* All code changes must be submitted via Pull Request. +* **Requirement:** At least **one** approval from a Maintainer is required to merge. + +## 4. Code of Conduct + +This project adheres to a **Code of Conduct**. +* [Link to Code of Conduct](https://github.com/flux-framework/flux-restful-api/blob/master/.github/CODE_OF_CONDUCT.md) +* Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project lead [sochat1@llnl.gov](mailto:sochat1@llnl.gov). + +## 5. Current Maintainers + +* **Vanessa Sochat** (@vsoch) - *Lawrence Livermore National Laboratory* diff --git a/README.md b/README.md index 8f6833e..cc9a7f9 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,7 @@ tool to generate a contributors graphic below. +Project interaction is governed by a Code of Conduct. Please see our [Code of Conduct](.github/CODE_OF_CONDUCT.md) for contributing. ## LICENSE