-
Notifications
You must be signed in to change notification settings - Fork 0
Add community governance files #12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # Contributor Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| We as members, contributors, and leaders pledge to make participation in our | ||
| community a welcoming experience for everyone. | ||
|
|
||
| We pledge to act and interact in ways that contribute to an open, friendly, | ||
| diverse, inclusive, and healthy community. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to a positive environment: | ||
|
|
||
| - Using welcoming and inclusive language | ||
| - Being respectful of differing viewpoints and experiences | ||
| - Gracefully accepting constructive criticism | ||
| - Focusing on what is best for the community | ||
| - Showing empathy towards other community members | ||
|
|
||
| Examples of unacceptable behavior: | ||
|
|
||
| - Trolling, insulting or derogatory comments, and personal attacks | ||
| - Public or private harassment | ||
| - Publishing others' private information without 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. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies within all community spaces, and also applies when | ||
| an individual is officially representing the community in public spaces. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of unacceptable behavior may be reported to the community leaders | ||
| responsible for enforcement at **conduct@proxysql.com**. | ||
|
|
||
| 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. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), | ||
| version 2.1, available at | ||
| https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. |
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,80 @@ | ||||||||||||||||||||||||||||||||||
| # Contributing to Orchestrator | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| Thank you for your interest in contributing to orchestrator! This project is maintained by [ProxySQL LLC](https://proxysql.com) and we welcome contributions from the community. | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ## How to Contribute | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ### Reporting Bugs | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Bug Report** template | ||||||||||||||||||||||||||||||||||
| - Include your orchestrator version, backend type (MySQL/SQLite), and sanitized configuration | ||||||||||||||||||||||||||||||||||
| - Provide topology information: `orchestrator-client -c topology -alias my-cluster` | ||||||||||||||||||||||||||||||||||
| - Include logs with `--debug --stack` flags for maximum verbosity | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| ### Suggesting Features | ||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Feature Request** template | ||||||||||||||||||||||||||||||||||
|
Comment on lines
+9
to
+16
|
||||||||||||||||||||||||||||||||||
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Bug Report** template | |
| - Include your orchestrator version, backend type (MySQL/SQLite), and sanitized configuration | |
| - Provide topology information: `orchestrator-client -c topology -alias my-cluster` | |
| - Include logs with `--debug --stack` flags for maximum verbosity | |
| ### Suggesting Features | |
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Feature Request** template | |
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) and follow the issue template | |
| - Include your orchestrator version, backend type (MySQL/SQLite), and sanitized configuration | |
| - Provide topology information: `orchestrator-client -c topology -alias my-cluster` | |
| - Include logs with `--debug --stack` flags for maximum verbosity | |
| ### Suggesting Features | |
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) and clearly mark the issue as a feature request |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is a common practice in the open-source community to use main as the default branch name instead of master for new projects or documentation. Consider updating this to main for consistency with modern Git workflows and inclusive language.
| 1. Fork the repository | |
| 2. Create a feature branch from `main` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Maintainers | ||
|
|
||
| Orchestrator is maintained by [ProxySQL LLC](https://proxysql.com). | ||
|
|
||
| ## Current Maintainers | ||
|
|
||
| | Name | GitHub | Role | | ||
| |------|--------|------| | ||
| | René Cannaò | [@renecannao](https://github.com/renecannao) | Project Lead | | ||
|
|
||
| ## Maintainer Responsibilities | ||
|
|
||
| - Review and merge pull requests | ||
| - Triage issues and feature requests | ||
| - Manage releases and versioning | ||
| - Set project direction and roadmap | ||
| - Ensure CI and code quality standards are maintained | ||
|
|
||
| ## Becoming a Maintainer | ||
|
|
||
| Consistent, high-quality contributions over time may lead to an invitation to join the maintainer team. If you're interested, start by contributing and engaging with the project. |
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,30 @@ | ||||||||||||||||||
| # Security Policy | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Reporting a Vulnerability | ||||||||||||||||||
|
|
||||||||||||||||||
| If you discover a security vulnerability in orchestrator, please report it responsibly. **Do not open a public GitHub issue.** | ||||||||||||||||||
|
|
||||||||||||||||||
| Email: **security@proxysql.com** | ||||||||||||||||||
|
|
||||||||||||||||||
| Please include: | ||||||||||||||||||
| - Description of the vulnerability | ||||||||||||||||||
| - Steps to reproduce | ||||||||||||||||||
| - Potential impact | ||||||||||||||||||
| - Suggested fix (if any) | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Response Timeline | ||||||||||||||||||
|
|
||||||||||||||||||
| - **Acknowledgment:** within 48 hours | ||||||||||||||||||
| - **Initial assessment:** within 7 days | ||||||||||||||||||
| - **Fix or mitigation:** timeline communicated after assessment | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Supported Versions | ||||||||||||||||||
|
|
||||||||||||||||||
| | Version | Supported | | ||||||||||||||||||
| |---------|-----------| | ||||||||||||||||||
| | 4.x | Yes | | ||||||||||||||||||
| | 3.x | No | | ||||||||||||||||||
|
Comment on lines
+23
to
+26
|
||||||||||||||||||
| | Version | Supported | | |
| |---------|-----------| | |
| | 4.x | Yes | | |
| | 3.x | No | | |
| | Version | Supported | | |
| |---------|-------------------------------| | |
| | 3.x | Yes | | |
| | 4.x | Planned (not yet released) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This references using the Bug Report issue template, but the repo currently only has a single
.github/ISSUE_TEMPLATE.md(no dedicated bug-report template). Please update the text to reflect the current issue template setup, or add the missing issue templates/forms.