Skip to content

Commit 01f7dbf

Browse files
authored
Added README.md (#9)
1 parent 52a47bd commit 01f7dbf

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Laravel Coding Guidelines
2+
3+
Welcome to Laravel Coding Guidelines! This repository contains a comprehensive guide to help developers follow best practices for writing clean, maintainable, and consistent code within Laravel projects.
4+
5+
You can access the live site showcasing the guidelines: https://xqsit94.github.io/laravel-coding-guidelines/
6+
7+
## What are Coding Guidelines?
8+
9+
Coding guidelines, also known as coding conventions or style guides, provide a set of recommendations and standards for writing code. These guidelines help ensure that the codebase is well-organized, readable, and follows established industry practices.
10+
11+
## Why Follow Laravel Coding Guidelines?
12+
13+
Adhering to coding guidelines is essential for maintaining code quality and consistency across projects. When developers follow a consistent set of standards, it becomes easier to collaborate, review code, and maintain the codebase over time. Consistent code also minimizes potential bugs and enhances the overall software development process.
14+
15+
## Contributing
16+
17+
We welcome contributions from the Laravel community to enhance and refine these coding guidelines. If you have suggestions, improvements, or new coding standards to propose, please feel free to open an issue or submit a pull request.
18+
19+
## Getting Started
20+
21+
To get started with the Laravel Coding Guidelines, you can:
22+
23+
1. **Explore the Live Site**: Visit the [live site](https://xqsit94.github.io/laravel-coding-guidelines/) to browse the guidelines.
24+
25+
2. **Clone the Repository**: If you want to contribute or have offline access, clone this repository and explore the documentation locally.
26+
27+
```bash
28+
git clone https://github.com/xqsit94/laravel-coding-guidelines.git
29+
```

0 commit comments

Comments
 (0)