Community Standards

This repository includes community standards that I personally use for my projects on GitHub.

File Structure

community-standards/
├── .github/
│   ├── ISSUE_TEMPLATE/
│   │   ├── bug_report.md
│   │   ├── custom.md
│   │   ├── documentation_update.md
│   │   └── feature_request.md
│   └── PULL_REQUEST_TEMPLATE.md
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── COMMIT_MESSAGE_GUIDELINES.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── SECURITY.md
└── TODO.md

• community-standards/ - This is the root directory of the repository, and it contains a directory for community standards.

• .github/ - This directory contains files specific to GitHub. These files include workflows, issue and pull request templates, and other configuration files.

• ISSUE_TEMPLATE/ - This directory contains all the issue templates. These templates help standardize the information provided in each issue and make it easier for contributors to submit issues that can be easily understood by others.

• bug_report.md - This file contains the bug report template. This template provides a structured way for contributors to report bugs they have found in the project.

• custom.md - This file contains the custom issue template. This template is a blank template that can be customized to fit the specific needs of the project.

• documentation_update.md - This file contains the documentation update template. This template provides a structured way for contributors to suggest updates or improvements to the project's documentation.

• feature_request.md - This file contains the feature request template. This template provides a structured way for contributors to suggest new features or improvements to the project.

• PULL_REQUEST_TEMPLATE.md - This file contains the pull request template. This template provides a structured way for contributors to submit code changes to the project.

• CHANGELOG.md - This file contains the changelog of the project. The changelog is a record of changes made to the project over time, including new features, bug fixes, and other improvements.

• CODE_OF_CONDUCT.md - This file contains the code of conduct of the project. The code of conduct outlines the behavior that is expected of contributors to the project.

• COMMIT_MESSAGE_GUIDELINES.md - This file contains the commit message guidelines of the project. The commit message guidelines provide guidance on how to write clear and informative commit messages when making changes to the project's codebase.

• CONTRIBUTING.md - This file contains the contributing guidelines of the project. The contributing guidelines provide guidance on how to contribute to the project, including how to report bugs, how to suggest new features, and how to submit code changes.

• LICENSE.md - This file contains the license of the project. The license outlines the terms and conditions under which the project's code can be used, modified, and distributed.

• README.md - This file contains the readme of the project. The readme provides a brief overview of the project, including its purpose and how to use it.

• SECURITY.md - This file contains the security policy of the project. The security policy outlines how to report security vulnerabilities in the project and how they will be handled.

• TODO.md - This file contains the tasks that need to be completed before the next release. This helps the project's maintainers keep track of what work needs to be done and what features or fixes are planned for the next release.

Contact

If you have any questions, feel free to contact via GitHub Discussions.

Or, you can contact me via email at [email protected].