134 lines
5.1 KiB
Markdown
134 lines
5.1 KiB
Markdown
<!-- Copyright (C) 2025 Moko Consulting <hello@mokoconsulting.tech>
|
|
|
|
This file is part of a Moko Consulting project.
|
|
|
|
SPDX-LICENSE-IDENTIFIER: GPL-3.0-or-later
|
|
|
|
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the IMPLIED WARRANTY of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License (./LICENSE).
|
|
|
|
# FILE INFORMATION
|
|
DEFGROUP:
|
|
INGROUP: Project.Documentation
|
|
REPO: mokoconsulting-tech/MokoStandards-Template-Generic
|
|
VERSION: 00.00.01
|
|
PATH: ./README.md
|
|
BRIEF: Generic coding project template according to MokoStandards
|
|
-->
|
|
|
|
|
|
[](https://github.com/mokoconsulting-tech/MokoStandards-Template-Generic/releases/tag/v00)
|
|
[](LICENSE)
|
|
[](https://www.php.net)
|
|
|
|
# MokoStandards-Template-Generic
|
|
|
|
[](https://github.com/RichardLitt/standard-readme)
|
|
|
|
A template repository for generic coding projects that follows MokoStandards conventions.
|
|
|
|
This template provides a standardized structure for any coding project, including proper documentation, licensing, contribution guidelines, and project organization. It is designed to help you quickly bootstrap new projects with best practices and consistent conventions.
|
|
|
|
## Table of Contents
|
|
|
|
- [Background](#background)
|
|
- [Install](#install)
|
|
- [Usage](#usage)
|
|
- [Structure](#structure)
|
|
- [Contributing](#contributing)
|
|
- [License](#license)
|
|
- [Maintainers](#maintainers)
|
|
|
|
## Background
|
|
|
|
MokoStandards-Template-Generic is a repository template designed to provide a consistent foundation for generic coding projects. It includes:
|
|
|
|
- Standard documentation structure (README, LICENSE, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG)
|
|
- MokoStandards-compliant file headers and metadata
|
|
- EditorConfig for consistent coding styles across editors
|
|
- Git configuration templates
|
|
- Documentation index system for easy navigation
|
|
|
|
This template follows the [standard-readme](https://github.com/RichardLitt/standard-readme) specification and incorporates MokoStandards conventions for enterprise-grade project organization.
|
|
|
|
## Install
|
|
|
|
To use this template:
|
|
|
|
1. Click the "Use this template" button on GitHub
|
|
2. Create a new repository from this template
|
|
3. Clone your new repository locally:
|
|
|
|
```sh
|
|
git clone https://github.com/your-username/your-new-repo.git
|
|
cd your-new-repo
|
|
```
|
|
|
|
4. Update the project-specific details:
|
|
- Update README.md with your project name and description
|
|
- Update LICENSE if using a different license
|
|
- Update file headers with appropriate REPO, DEFGROUP, and BRIEF values
|
|
- Update CHANGELOG.md with your version history
|
|
|
|
## Usage
|
|
|
|
This template is designed to be customized for your specific project needs.
|
|
|
|
### Getting Started
|
|
|
|
1. Replace placeholder text with your project details
|
|
2. Add your source code to the `src/` directory
|
|
3. Add scripts to the `scripts/` directory
|
|
4. Add documentation to the `docs/` directory
|
|
5. Update the CHANGELOG.md as you make changes
|
|
|
|
### Project Structure
|
|
|
|
```
|
|
.
|
|
├── docs/ # Documentation files
|
|
├── scripts/ # Build and utility scripts
|
|
├── src/ # Source code
|
|
├── README.md # This file
|
|
├── LICENSE # License information
|
|
├── CONTRIBUTING.md # Contribution guidelines
|
|
├── CODE_OF_CONDUCT.md # Code of conduct
|
|
└── CHANGELOG.md # Version history
|
|
```
|
|
|
|
## Structure
|
|
|
|
The repository follows MokoStandards conventions:
|
|
|
|
- **Documentation**: All `.md` files include copyright headers and file metadata
|
|
- **Index Files**: Each directory contains an `index.md` for navigation
|
|
- **EditorConfig**: Maintains consistent coding styles (tabs, width 2)
|
|
- **Git Configuration**: Includes `.gitattributes`, `.gitignore`, and `.gitmessage` templates
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
|
|
|
|
This project follows the [Contributor Covenant](CODE_OF_CONDUCT.md) Code of Conduct.
|
|
|
|
## License
|
|
|
|
This project is licensed under the GNU General Public License v3.0 or later - see the [LICENSE](LICENSE) file for details.
|
|
|
|
Copyright © 2025 Moko Consulting <hello@mokoconsulting.tech>
|
|
|
|
## Maintainers
|
|
|
|
[@mokoconsulting-tech](https://github.com/mokoconsulting-tech)
|
|
|
|
For questions or support, please contact: hello@mokoconsulting.tech
|
|
|
|
## Revision History
|
|
|
|
| Date | Version | Author | Notes |
|
|
| --- | --- | --- | --- |
|
|
| 2026-01-16 | 0.1.0 | Copilot | Initial MokoStandards-compliant README |
|