https://github.com/ekovegeance/styleguide
Style Guides for Consistent Development
https://github.com/ekovegeance/styleguide
atomic-design conventional-commits design documentation laravel nextjs php semantic-versioning styleguide typescript vscode
Last synced: 2 months ago
JSON representation
Style Guides for Consistent Development
- Host: GitHub
- URL: https://github.com/ekovegeance/styleguide
- Owner: ekovegeance
- License: mit
- Created: 2024-12-18T15:14:44.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-17T10:17:08.000Z (3 months ago)
- Last Synced: 2025-02-13T09:12:54.805Z (2 months ago)
- Topics: atomic-design, conventional-commits, design, documentation, laravel, nextjs, php, semantic-versioning, styleguide, typescript, vscode
- Homepage: https://ekovegeance.github.io/styleguide/
- Size: 103 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Style Guides for Consistent Development
Welcome to the **Style Guides** repository! This project serves as a centralized hub for all coding, design, and documentation standards to ensure consistent and high-quality development across projects.
## Purpose
The purpose of these style guides is to:
- **Maintain Code Quality:** Establish best practices for writing clean, maintainable, and efficient code.
- **Enhance Collaboration:** Provide a common reference for teams to work cohesively.
- **Improve Design Consistency:** Define rules for UI/UX design to create visually appealing and user-friendly interfaces.
- **Standardize Documentation:** Set a clear format for project documentation to improve readability and understanding.
## Features
- **Coding Standards**
- [Laravel, Inertia (React Typescript)](https://ekovegeance.github.io/styleguide/coding/laravel)
- [Next.Js App Router (Typescript)](https://github.com/ekovegeance/styleguide/blob/main/coding/nextjs.md)
- **Design Guidelines**
- [Atomic Design principles](https://ekovegeance.github.io/styleguide/design/atomic)
- [Accessibility standards](https://ekovegeance.github.io/styleguide/design/accessibility)
- **Documentation Rules**
- [Markdown formatting](https://ekovegeance.github.io/styleguide/documentation/markdown)
- [Commenting practices](https://ekovegeance.github.io/styleguide/documentation/comments)
- [Conventional Commit](https://github.com/ekovegeance/styleguide/blob/main/documentation/commit.md)
- [Semantic Versioning](https://github.com/ekovegeance/styleguide/blob/main/documentation/versioning.md)
## Getting Started
Follow these steps to start using the style guides:
1. Clone this repository:
```bash
https://github.com/ekovegeance/styleguide.git
```
2. Navigate to the project directory:
```bash
cd styleguide
```
3. Explore the style guides in the respective folders:
- `coding/` for coding standards
- `design/` for UI/UX design guidelines
- `documentation/` for rules on documentation
## Contributing
We welcome contributions to improve and expand these style guides. To contribute:
1. Fork the repository and create a new branch:
```bash
git checkout -b feature/
```
2. Make your changes and commit them:
```bash
git commit -m "Add "
```
3. Push to your fork and submit a pull request.
## License
This project is licensed under the [MIT License](LICENSE).
## Contact
For questions, suggestions, or feedback, please open an issue or contact us at .
---
**Happy Coding!**
"Consistency is the key to perfection."