This repository includes community standards that I personally use for my projects on GitHub.
community-standards/
├── .github/
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ ├── documentation_update.md
│ │ ├── feature_request.md
│ │ ├── feedback.md
│ │ └── other.md
│ └── PULL_REQUEST_TEMPLATE.md
├── BRANCH_NAMING_GUIDELINES.md
├── CHANGELOG.md
├── CITATION.cff
├── CODE_OF_CONDUCT.md
├── COMMIT_MESSAGE_GUIDELINES.md
├── CONTRIBUTING.md
├── LICENSE
├── PULL_REQUEST_GUIDELINES.md
├── README.md
├── SECURITY.md
├── TODO.md
└── VERSIONING.md-
.github/ - GitHub-specific configuration: issue and pull request templates.
-
ISSUE_TEMPLATE/ - Pre-made forms that guide contributors to report consistent issues.
-
bug_report.md - Form for reporting bugs with all necessary details.
-
documentation_update.md - Form for suggesting documentation improvements.
-
feature_request.md - Form for proposing new features and enhancements.
-
feedback.md - Form for sharing general feedback and ideas.
-
other.md - Form for issues that don't fit other categories.
-
-
PULL_REQUEST_TEMPLATE.md - Checklist to ensure pull requests are complete and reviewed properly.
-
-
BRANCH_NAMING_GUIDELINES.md - Standards for naming branches clearly and consistently.
-
CHANGELOG.md - Record of all project updates, features, and fixes organized by version.
-
CITATION.cff - Proper format for citing this project in academic or formal references.
-
CODE_OF_CONDUCT.md - Community standards for respectful and inclusive behavior.
-
COMMIT_MESSAGE_GUIDELINES.md - Standards for writing clear and descriptive commit messages.
-
CONTRIBUTING.md - Step-by-step guide for contributing to the project, including issues and pull requests.
-
LICENSE - Legal license defining how the project can be used, modified, and distributed.
-
PULL_REQUEST_GUIDELINES.md - Best practices for naming, describing, and submitting pull requests.
-
README.md - This file: overview and structure of the project.
-
SECURITY.md - Guidelines for responsibly reporting security vulnerabilities.
-
TODO.md - Planned tasks and features scheduled for upcoming releases.
-
VERSIONING.md - Versioning strategy for tracking releases and backward compatibility.
If you have any questions or suggestions regarding these community standards, feel free to open an issue or submit a pull request in this repository.
You can also reach me via email at: contact@dileepa.dev
