A centralized repository of templates and guidelines for the ByteProgramming organization
This repository serves as the official library of templates and guidelines used across all ByteProgramming projects. It contains standardized templates for documentation, contribution guidelines, issue templates, pull request templates, and more.
The purpose of this repository is to:
- ✅ Maintain consistency across all organization projects
- ✅ Streamline the setup process for new repositories
- ✅ Ensure all team members follow the same standards
- ✅ Provide a single source of truth for documentation templates
| File | Description | Usage |
|---|---|---|
| readme-template.md | Complete README template for any project | Copy and customize for your project's README |
| CONTRIBUTING.md | Contribution guidelines for all repos | Copy to your repository to enforce standards |
| issues.md | Issue template structure | Use as GitHub issue template |
| pull-request.md | Pull request template structure | Use as GitHub PR template |
- Copy the templates you need from this repository
- Customize them according to your project's specifics
- Follow the guidelines defined in CONTRIBUTING.md
- Maintain consistency with the organization's standards
- Review your current documentation against these templates
- Update your docs to match the organization's standards
- Implement any missing templates
- Ensure your team follows the CONTRIBUTING guidelines
All projects in the ByteProgramming organization must:
- 🌍 Use English for all code, comments, and documentation
- 📝 Follow Conventional Commits for commit messages
- 🔀 Use proper branch naming conventions
- ✅ Write tests for all code changes
- 📚 Document code using technology-specific standards
- 🔍 Follow the PR template for all pull requests
- 🐛 Create issues before starting work
For detailed guidelines, see CONTRIBUTING.md.