docs: Added essential repository files#10
Merged
Conversation
Introduced GitHub issue templates for bug reports and feature requests to standardize and streamline the issue submission process. Also enabled blank issues via config.yml.
Updated the README to include a screenshot and reorganized the table of contents.
Added CONTRIBUTING.md with contribution guidelines, and created docs/usage.md and docs/configuration.md for detailed usage and configuration instructions. Updated README.md to provide a concise overview, improved feature descriptions, and linked to the new documentation files.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 community and project documentation for the
tmpoCLI, including a comprehensive README, a Contributor Covenant Code of Conduct, funding and issue templates, and configuration for GitHub Issues. These changes help establish clear guidelines for contributors, streamline project onboarding, and improve project transparency.Documentation and Community Guidelines:
README.mdwith installation instructions, usage examples, feature overview, configuration details, development setup, and contribution guidelines.CODE_OF_CONDUCT.mdto set expectations for community behavior and outline enforcement procedures.GitHub Issue and Funding Configuration:
.github/ISSUE_TEMPLATE/bug_report.ymland.github/ISSUE_TEMPLATE/feature_request.ymlto standardize bug reports and feature requests, improving issue triage and communication. [1] [2].github/ISSUE_TEMPLATE/config.ymlfor flexibility in issue creation..github/FUNDING.ymlto specify supported funding platforms and encourage sponsorship for the project.