This document outlines the guidelines and best practices to ensure consistency, maintainability, and quality across the project. Following these guidelines will help streamline collaboration and improve the overall development process.
Table of Contents
- Repository Guidelines
- Code Guidelines
- Development/Integration Guidelines
- Keep Files Updated
- Updating CHANGELOG
- Other Guidelines
Follow the Repository Guidelines for detailed instructions on managing the repository.
Please adhere to the following coding standards and practices:
- HTML Code Guidelines
- CSS and Sass Code Guidelines
- JavaScript Code Guidelines
- Markdown Guidelines
- VS Code Settings -PHP Code Guidelines
- Follow Dev Tools to install development tools.
- Follow the website code structure for organizing your project files.
Always keep the following files up to date:
- README
- LICENSE
- Remove the additional files and folders in
/docs/that are not needed for your project.
Follow the Changelog Guidelines for detailed instructions on maintaining the changelogs.
Add any additional guidelines specific to your project here, such as document software configuration or team-specific practices.