Add usage examples in README, add PR template #16
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
github-actions
bot
added
the
documentation
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.
This pull request includes several updates to the documentation files to improve clarity and provide additional resources. The most important changes include the addition of a changes section and checklist to the pull request template, the removal of the contribution guidelines from the
CONTRIBUTING.mdfile, and the enhancement of theREADME.mdfile with new sections and examples for reusable workflows and markdown templates.Documentation updates:
.github/pull_request_template.md: Added a changes section and a checklist to guide contributors in providing necessary information and ensuring completeness.CONTRIBUTING.md: Removed the contribution guidelines, which were previously included in this file.README.md: Enhanced with new sections, including examples for reusable workflows and markdown templates, to provide better guidance and resources for users.