Skip to content
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

chore : add contribution docs #16

Merged
merged 6 commits into from
Mar 27, 2025
Merged

chore : add contribution docs #16

merged 6 commits into from
Mar 27, 2025

Conversation

michiosw
Copy link
Contributor

@michiosw michiosw commented Mar 18, 2025

This pull request includes several important updates to the project's documentation and templates. The changes introduce new issue and pull request templates, a code of conduct, contributing guidelines, and a license file.

Documentation and Templates Updates:

Project Governance:

  • CODE_OF_CONDUCT.md: Added a Contributor Covenant Code of Conduct to establish community standards and enforcement guidelines.
  • CONTRIBUTING.md: Created contributing guidelines to provide clear instructions on how to contribute to the project, including workflows and guidelines for non-code contributions, reporting bugs, suggesting enhancements, and submitting pull requests.

Licensing:

  • LICENSE: Added an MIT License to the project to define the terms under which the software can be used and distributed.

Issues:

@michiosw michiosw requested a review from hashkode March 18, 2025 14:29
@michiosw michiosw added the documentation Improvements or additions to documentation label Mar 18, 2025
@michiosw michiosw changed the title Chore/add contribution docs chore : add contribution docs Mar 18, 2025
@michiosw michiosw self-assigned this Mar 18, 2025
@hashkode hashkode force-pushed the chore/add-contribution-docs branch from 8b56ccb to 57d7b9d Compare March 18, 2025 22:43
- Introduced a Contributor Covenant Code of Conduct to promote a respectful and inclusive community.
- Updated CONTRIBUTING.md to include a link to the Code of Conduct, added a 'Getting Started' section, and refined the guidelines for reporting bugs and suggesting enhancements.
- Added templates for bug reports and feature requests to streamline issue tracking and contributions.
@hashkode hashkode force-pushed the chore/add-contribution-docs branch from 3637571 to 5f30102 Compare March 26, 2025 21:33
@michiosw
Copy link
Contributor Author

lgtm

@michiosw michiosw merged commit 2cfdaa1 into main Mar 27, 2025
3 checks passed
@michiosw michiosw deleted the chore/add-contribution-docs branch March 27, 2025 23:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Is there a LICENSE.md
2 participants