Add initial documentation: README, CONTRIBUTING, and CODE_OF_CONDUCT files #23
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #23 +/- ##
=======================================
Coverage 81.64% 81.64%
=======================================
Files 1 1
Lines 158 158
=======================================
Hits 129 129
Misses 22 22
Partials 7 7 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
The changes introduce three new documentation files to the project:
README.md: Provides an overview of the Protoconf Golang Client, including features, installation instructions, usage examples, contribution guidelines, and license information.
CONTRIBUTING.md: Offers detailed guidelines for contributing to the project, including reporting bugs, suggesting enhancements, and improving documentation. It also includes a code of conduct and style guides for commit messages.
CODE_OF_CONDUCT.md: Establishes a code of conduct for contributors, outlining acceptable and unacceptable behaviors, responsibilities of maintainers, scope of the code, and enforcement procedures.