docs: add community health files and README updates #10638
+87
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # 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 will be listed here | ||
|
|
||
| ### Changed | ||
| - Ongoing updates | ||
|
|
||
| ### Fixed | ||
| - Bug fixes | ||
|
|
||
| --- | ||
| *[Mukller](https://github.com/Mukller)* | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,30 @@ | ||||||
| # 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. | ||||||
|
|
||||||
| ## Our Standards | ||||||
|
|
||||||
| Examples of behavior that contributes to a positive environment: | ||||||
| - Using welcoming and inclusive language | ||||||
| - Being respectful of differing viewpoints | ||||||
| - Gracefully accepting constructive criticism | ||||||
| - Focusing on what is best for the community | ||||||
|
|
||||||
| Examples of unacceptable behavior: | ||||||
| - Harassment of any kind | ||||||
| - Trolling, insulting or derogatory comments | ||||||
| - Public or private harassment | ||||||
| - Publishing others' private information without permission | ||||||
|
|
||||||
| ## Enforcement | ||||||
|
|
||||||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers. | ||||||
|
Contributor
There was a problem hiding this comment. The enforcement section mentions reporting to project maintainers but does not provide a contact method (such as an email address or a link to a reporting form). Please add a placeholder or a specific email address where violations can be reported.
Suggested change
|
||||||
|
|
||||||
| ## Attribution | ||||||
|
|
||||||
| This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1. | ||||||
|
|
||||||
| --- | ||||||
| *[Mukller](https://github.com/Mukller)* | ||||||
|
Comment on lines
+29
to
+30
Contributor
There was a problem hiding this comment. Please remove the personal signature block from the Code of Conduct, as individual contributions are tracked via Git history rather than inline signatures. |
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Contributing | ||
|
|
||
| Thank you for your interest in contributing! | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. Fork the repository | ||
| 2. Create a feature branch: `git checkout -b feature/your-feature` | ||
| 3. Make your changes | ||
| 4. Run tests: `pytest` | ||
| 5. Submit a Pull Request | ||
|
|
||
| ## Code Style | ||
|
|
||
| - Follow existing code style and conventions | ||
| - Write clear, descriptive commit messages | ||
| - Add tests for new features | ||
|
|
||
| ## Reporting Issues | ||
|
|
||
| Use GitHub Issues to report bugs or request features. Please include: | ||
| - Steps to reproduce | ||
| - Expected vs actual behavior | ||
| - Environment details | ||
|
|
||
| ## Pull Request Guidelines | ||
|
|
||
| - Keep PRs focused on a single change | ||
| - Update documentation as needed | ||
| - Ensure all tests pass | ||
|
|
||
| --- | ||
| *[Mukller](https://github.com/Mukller)* | ||
|
Comment on lines
+32
to
+33
Contributor
There was a problem hiding this comment. Please remove the personal signature block from the contributing guidelines, as individual contributions are tracked via Git history rather than inline signatures. |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Please remove the personal signature block from the changelog, as individual contributions are tracked via Git history rather than inline signatures.