-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add Code of Conduct and templates #15
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
base: main
Are you sure you want to change the base?
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,38 @@ | ||||||
| --- | ||||||
| name: Bug report | ||||||
| about: Create a report to help us improve | ||||||
| title: '' | ||||||
| labels: '' | ||||||
| assignees: '' | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| **Describe the bug** | ||||||
| A clear and concise description of what the bug is. | ||||||
|
|
||||||
| **To Reproduce** | ||||||
| Steps to reproduce the behavior: | ||||||
| 1. Go to '...' | ||||||
| 2. Click on '...' | ||||||
| 3. Scroll down to '...' | ||||||
| 4. See error | ||||||
|
|
||||||
| **Expected behavior** | ||||||
| A clear and concise description of what you expected to happen. | ||||||
|
|
||||||
| **Screenshots** | ||||||
| If applicable, add screenshots to help explain your problem. | ||||||
|
|
||||||
| **Desktop (please complete the following information):** | ||||||
| - OS: [e.g. iOS] | ||||||
| - Browser [e.g. chrome, safari] | ||||||
| - Version [e.g. 22] | ||||||
|
|
||||||
| **Smartphone (please complete the following information):** | ||||||
| - Device: [e.g. iPhone6] | ||||||
|
||||||
| - Device: [e.g. iPhone6] | |
| - Device: [e.g. iPhone 6] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| name: Feature request | ||
| about: Suggest an idea for this project | ||
| title: '' | ||
| labels: '' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| **Is your feature request related to a problem? Please describe.** | ||
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
|
||
| **Describe the solution you'd like** | ||
| A clear and concise description of what you want to happen. | ||
|
|
||
| **Describe alternatives you've considered** | ||
| A clear and concise description of any alternative solutions or features you've considered. | ||
|
|
||
| **Additional context** | ||
| Add any other context or screenshots about the feature request here. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| ## Description | ||
|
|
||
| Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. | ||
|
|
||
| Fixes # (issue) | ||
|
|
||
| ## Type of change | ||
|
|
||
| Please delete options that are not relevant. | ||
|
|
||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||
| - [ ] New feature (non-breaking change which adds functionality) | ||
| - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
| - [ ] This change requires a documentation update | ||
|
|
||
| ## How Has This Been Tested? | ||
|
|
||
| Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration | ||
|
|
||
| - [ ] Test A | ||
| - [ ] Test B | ||
|
|
||
| ## Checklist: | ||
|
|
||
| - [ ] My code follows the style guidelines of this project | ||
| - [ ] I have performed a self-review of my own code | ||
| - [ ] I have commented my code, particularly in hard-to-understand areas | ||
| - [ ] I have made corresponding changes to the documentation | ||
| - [ ] My changes generate no new warnings | ||
| - [ ] I have added tests that prove my fix is effective or that my feature works | ||
| - [ ] New and existing unit tests pass locally with my changes | ||
| - [ ] Any dependent changes have been merged and published in downstream modules |
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,74 @@ | ||||||||||||||||||
| # Contributor Covenant Code of Conduct | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Our Pledge | ||||||||||||||||||
|
|
||||||||||||||||||
| In the interest of fostering an open and welcoming environment, we as | ||||||||||||||||||
| contributors and maintainers pledge to making participation in our project and | ||||||||||||||||||
| our community a harassment-free experience for everyone, regardless of age, body | ||||||||||||||||||
| size, disability, ethnicity, gender identity and expression, level of experience, | ||||||||||||||||||
| nationality, personal appearance, race, religion, or sexual identity and | ||||||||||||||||||
| orientation. | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Our Standards | ||||||||||||||||||
|
|
||||||||||||||||||
| Examples of behavior that contributes to creating a positive environment | ||||||||||||||||||
| include: | ||||||||||||||||||
|
|
||||||||||||||||||
| * 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 by participants include: | ||||||||||||||||||
|
|
||||||||||||||||||
| * The use of sexualized language or imagery and unwelcome sexual attention or | ||||||||||||||||||
| advances | ||||||||||||||||||
| * Trolling, insulting/derogatory comments, and personal or political attacks | ||||||||||||||||||
| * Public or private harassment | ||||||||||||||||||
| * Publishing others' private information, such as a physical or electronic | ||||||||||||||||||
| address, without explicit permission | ||||||||||||||||||
| * Other conduct which could reasonably be considered inappropriate in a | ||||||||||||||||||
| professional setting | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Our Responsibilities | ||||||||||||||||||
|
|
||||||||||||||||||
| Project maintainers are responsible for clarifying the standards of acceptable | ||||||||||||||||||
| behavior and are expected to take appropriate and fair corrective action in | ||||||||||||||||||
| response to any instances of unacceptable behavior. | ||||||||||||||||||
|
|
||||||||||||||||||
| Project maintainers 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, or to ban temporarily or | ||||||||||||||||||
| permanently any contributor for other behaviors that they deem inappropriate, | ||||||||||||||||||
| threatening, offensive, or harmful. | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Scope | ||||||||||||||||||
|
|
||||||||||||||||||
| This Code of Conduct applies both within project spaces and in public spaces | ||||||||||||||||||
| when an individual is representing the project or its community. Examples of | ||||||||||||||||||
| representing a project or community include using an official project e-mail | ||||||||||||||||||
| address, posting via an official social media account, or acting as an appointed | ||||||||||||||||||
| representative at an online or offline event. Representation of a project may be | ||||||||||||||||||
| further defined and clarified by project maintainers. | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Enforcement | ||||||||||||||||||
|
|
||||||||||||||||||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||||||||||||||||||
| reported by contacting the project team at [INSERT EMAIL ADDRESS]. All | ||||||||||||||||||
|
||||||||||||||||||
| reported by contacting the project team at [INSERT EMAIL ADDRESS]. All | |
| reported by contacting the project team at coc@project-maintainers.org. All |
Copilot
AI
Feb 28, 2026
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.
The attribution links use plain HTTP for contributor-covenant.org. Prefer HTTPS URLs here to avoid insecure redirects and to match typical documentation/linking practices.
| available at [http://contributor-covenant.org/version/1/4][version] | |
| [homepage]: http://contributor-covenant.org | |
| [version]: http://contributor-covenant.org/version/1/4/ | |
| available at [https://contributor-covenant.org/version/1/4][version] | |
| [homepage]: https://contributor-covenant.org | |
| [version]: https://contributor-covenant.org/version/1/4/ |
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.
In the Desktop section, the OS example is "iOS", which is a mobile OS. Consider using desktop OS examples (e.g., Windows/macOS/Linux) to reduce confusion when filing reports.