docs: add contributing guide and code of conduct #64
Conversation
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
dimarb
approved these changes
Nov 4, 2025
|
Added a "Contributing" section to the README.md with links and guidance for new contributors. |
Collaborator
|
Thanks a ton! However, the repo is currently still in development and I'm unsure of the workflow. Closing this for no. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This pull request introduces essential project documentation to support contributors and maintainers. The main additions include a contributing guide, a code of conduct, a bug report issue template, and updates to the
README.mdto reference these resources. These changes make it easier for new contributors to get started and ensure a welcoming and organized community.Documentation and Community Guidelines
CONTRIBUTING.mdfile with instructions for getting started, making pull requests, running tests, and reporting bugs.CODE_OF_CONDUCT.mdfile outlining expected behavior and reporting procedures, following the Contributor Covenant v3.0.Issue Reporting
.github/ISSUE_TEMPLATE/bug_report.mdto standardize bug submissions and improve reproducibility.README Updates
README.mdwith links and guidance for new contributors.README.mdto include the new "Contributing" section.