bhdicaire/repositoryTemplate
Repository template with batteries included
This repository is a template you can use to start new projects with a consistent structure and batteries included.
📔 Ingredients
Standard community files
Setup contributing guidelines to help collaborators make meaningful, useful contributions to a project:
- Code of conducts adapted from the Contributor Covenant, version 3.0 to ensure that no manual changes are required per project
- Code owners: lists the project's maintainers to specific areas of the codebase
- Contributing: reporting bugs & issues, and submitting pull requests based on Github Flow
- Governance: describe how decisions are made and how contributions are managed
- License: it uses a MIT License
- Maintainers: lists the project's maintainers and how to contact them
- Security: provide public instructions for reporting security issues
GitHub issue and PR templates for bugs, features, docs, and questions
-
Config: customize the issue template chooser
-
Labels: add labels for type (bug, feature, docs), status (in progress, blocked), and priority
-
Pull request template: explain how contributors can keep pull requests small and focused
-
Support: explain how contributors can get help
-
Issue templates:
More opinionated configurations
- .editorconfig: helps maintain consistent coding styles across various editors and IDEs 🔗source
- .gitattributes: control how GitHub shows diffs and calculates repository languages 🔗source
- .gitignore: keep sensitive or unnecessary files out of the repository 🔗source
- .markdownlint.yml: style checker and lint tool for Markdown/CommonMark files 🔗source
- CHANGELOG.md: maintain a change log following Keep a Changelog format
- package.json: information about the repository and required node.js modules 🔗source
🚀 Deployment
Click to create a new repository with this template
Customize based based on best practices
- Change the project description
- Update the standard community files
- Review
.github/LICENSE.md - Review
.github/CODE_OF_CONDUCT.md - Review
.github/GOVERNANCE.md - Review
.github/CONTRIBUTING.md - Update
.github/MAINTAINERS.md - Update
.github/CODEOWNERS - Update
.github/SECURITY.md - Configure the
private vulnerability reportingin the GitHub UI
- Review
- Update the Issues & PRs
- Review
.github/SUPPORT.md - Review
.github/ISSUE_TEMPLATE/config.md - Review
.github/ISSUE_TEMPLATE/bug.yml - Review
.github/ISSUE_TEMPLATE/docs.yml - Review
.github/ISSUE_TEMPLATE/feature-request.yml - Review
.github/ISSUE_TEMPLATE/question-support.yml - Review
.github/SECURITY.md - Review
.github/labels.yml - Review
.github/pull_request_template.md
- Review
- Update Opinionated configurations
- Review
.editorconfig - Review
.markdownlint.yml - Review
package.json - Review
CHANGELOG.md - Review
.gitignore - Review
.gitattributes
- Review
- Update Documentation
- Review GitHub Accounts and Organisations settings
- Strong and unique passwords
- Enforce two-factor authentication
- Use SSH Keys for authentication and commit signing
- Enable push protection to prevent committing secrets
- Assign at least two owners per organization to ensure continuity
🌲 Project tree
.
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .markdownlint.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package.json
├── .github
│ ├── CODEOWNERS
│ ├── CODE_OF_CONDUCT.md
│ ├── CONTRIBUTING.md
│ ├── GOVERNANCE.md
│ ├── LICENSE.md
│ ├── MAINTAINERS.md
│ ├── SECURITY.md
│ ├── SUPPORT.md
│ ├── labels.yml
│ ├── pull_request_template.md
│ └── ISSUE_TEMPLATE
│ ├── bug.yml
│ ├── config.yml
│ ├── docs.yml
│ ├── feature-request.yml
│ └── question-support.yml
└── docs
├── badges.md
├── bestPractices.md
├── emojis.md
├── header.png
├── permanentLinks.png
├── projectDescription.png
├── repoPrivateReporting.png
├── socialMedia.png
└── userPrivateReporting.png
4 directories, 32 files
Suggestions and improvements are welcome
Pull requests are welcome 😁
For major changes, please open an issue first to discuss what you would like to change. Refer to the contribution guidelines and adhere to this project's code of conduct.
License
Copyright (c) 2025 Benoît H. Dicaire and licensed under the MIT license. See LICENSE.md for more information.