-
Notifications
You must be signed in to change notification settings - Fork 2.1k
docs: add community health files (CONTRIBUTING.md, CODE_OF_CONDUCT.md, CHANGELOG.md) #3511
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,36 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ### Added | ||
| - Future features and improvements will be listed here | ||
|
|
||
| ### Changed | ||
| - Ongoing updates and modifications | ||
|
|
||
| ### Fixed | ||
| - Bug fixes and corrections | ||
|
|
||
| --- | ||
|
|
||
| ## How to Update This Changelog | ||
|
|
||
| When making changes, add an entry under `[Unreleased]` in the appropriate category: | ||
|
|
||
| - **Added** – new features | ||
| - **Changed** – changes to existing functionality | ||
| - **Deprecated** – soon-to-be removed features | ||
| - **Removed** – removed features | ||
| - **Fixed** – bug fixes | ||
| - **Security** – vulnerability fixes | ||
|
|
||
| When releasing, change `[Unreleased]` to the version number and date, | ||
| then add a new empty `[Unreleased]` section at the top. | ||
|
|
||
| --- | ||
| *Documentation contributed by [Mukller](https://github.com/Mukller)* | ||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,67 @@ | ||||||||||
| # 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, caste, color, 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. | ||||||||||
|
|
||||||||||
| ## 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 abusive, harassing, or otherwise unacceptable behavior may be | ||||||||||
| reported to the community leaders responsible for enforcement. | ||||||||||
|
Comment on lines
+53
to
+54
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The Code of Conduct needs a specific, private contact method (such as an email address or a private form) for reporting violations. Without this, contributors have no safe way to report harassment or other issues.
Suggested change
|
||||||||||
| All complaints will be reviewed and investigated promptly and fairly. | ||||||||||
|
|
||||||||||
| ## Attribution | ||||||||||
|
|
||||||||||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||||||||||
| version 2.1, available at | ||||||||||
| [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. | ||||||||||
|
|
||||||||||
| [homepage]: https://www.contributor-covenant.org | ||||||||||
| [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html | ||||||||||
|
|
||||||||||
| --- | ||||||||||
| *Documentation contributed by [Mukller](https://github.com/Mukller)* | ||||||||||
|
Comment on lines
+66
to
+67
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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,54 @@ | ||||||||||
| # Contributing | ||||||||||
|
|
||||||||||
| Thank you for your interest in contributing! We appreciate all contributions, | ||||||||||
| from bug reports to feature requests and code improvements. | ||||||||||
|
|
||||||||||
| ## How to Contribute | ||||||||||
|
|
||||||||||
| ### Reporting Bugs | ||||||||||
| - Check existing [issues](../../issues) first to avoid duplicates | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Using a root-relative link
Suggested change
|
||||||||||
| - Open a new issue with a clear title and description | ||||||||||
| - Include steps to reproduce, expected vs actual behavior, and environment details | ||||||||||
|
|
||||||||||
| ### Suggesting Features | ||||||||||
| - Open an issue with the `enhancement` label | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. On GitHub, general contributors do not have permissions to add labels (like
Suggested change
|
||||||||||
| - Describe the feature and explain why it would be valuable | ||||||||||
|
|
||||||||||
| ### Submitting Code | ||||||||||
|
|
||||||||||
| 1. **Fork** this repository | ||||||||||
| 2. **Create a branch** from `main`: | ||||||||||
| ```bash | ||||||||||
| git checkout -b feature/your-feature-name | ||||||||||
| ``` | ||||||||||
| 3. **Make your changes** and add tests if applicable | ||||||||||
| 4. **Commit** with a clear message: | ||||||||||
| ```bash | ||||||||||
| git commit -m "feat: add your feature description" | ||||||||||
| ``` | ||||||||||
| 5. **Push** to your fork and open a **Pull Request** | ||||||||||
|
|
||||||||||
| ## Guidelines | ||||||||||
|
|
||||||||||
| - Follow the existing code style and conventions | ||||||||||
| - Keep PRs focused on a single concern | ||||||||||
| - Write clear commit messages | ||||||||||
| - Update documentation when changing behavior | ||||||||||
| - Be respectful and constructive in all interactions (see [Code of Conduct](CODE_OF_CONDUCT.md)) | ||||||||||
|
|
||||||||||
| ## Development Setup | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| # Clone your fork | ||||||||||
| git clone https://github.com/YOUR_USERNAME/REPO_NAME.git | ||||||||||
| cd REPO_NAME | ||||||||||
|
Comment on lines
+43
to
+44
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since this is the
Suggested change
|
||||||||||
|
|
||||||||||
| # Install dependencies (see README for details) | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| ## Questions? | ||||||||||
|
|
||||||||||
| Open an issue or start a discussion — we're happy to help! | ||||||||||
|
|
||||||||||
| --- | ||||||||||
| *Documentation contributed by [Mukller](https://github.com/Mukller)* | ||||||||||
|
Comment on lines
+53
to
+54
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||||||
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.
Official community health files like
CHANGELOG.mdrepresent the project as a whole and typically do not include personal contribution footers. Additionally, the[Unreleased]header at the top of the file should have a corresponding link reference at the bottom of the file to compare changes. Let's remove the footer and add the link reference placeholder.