Skip to content

Commit 252d3a5

Browse files
committed
Update the read me and contribution guide.
1 parent b257d84 commit 252d3a5

File tree

2 files changed

+4
-31
lines changed

2 files changed

+4
-31
lines changed

CONTRIBUTING.md

+1-26
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,3 @@
11
# Laravel Contribution Guide
22

3-
This page contains guidelines for contributing to the Laravel framework. Please review these guidelines before submitting any pull requests to the framework.
4-
5-
## Which Branch?
6-
7-
**ALL** bug fixes should be made to the 4.x branch which they belong. Bug fixes should never be sent to the `master` branch unless they fix features that exist only in the upcoming release.
8-
9-
## Pull Requests
10-
11-
The pull request process differs for new features and bugs. Before sending a pull request for a new feature, you should first create an issue with `[Proposal]` in the title. The proposal should describe the new feature, as well as implementation ideas. The proposal will then be reviewed and either approved or denied. Once a proposal is approved, a pull request may be created implementing the new feature. Pull requests which do not follow this guideline will be closed immediately.
12-
13-
Pull requests for bugs may be sent without creating any proposal issue. If you believe that you know of a solution for a bug that has been filed on GitHub, please leave a comment detailing your proposed fix.
14-
15-
You should ensure that the current tests pass, and if you've added something new, add the tests where relevant. Please send a coherent commit history, making sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
16-
17-
### Feature Requests
18-
19-
If you have an idea for a new feature you would like to see added to Laravel, you may create an issue on GitHub with `[Request]` in the title. The feature request will then be reviewed by [@taylorotwell](https://github.com/taylorotwell).
20-
21-
## Coding Guidelines
22-
23-
Laravel follows the [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) and [PSR-1](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md) coding standards. In addition to these standards, below is a list of other coding standards that should be followed:
24-
25-
- Namespace declarations should be on the same line as `<?php`.
26-
- Class opening `{` should be on the same line as the class name.
27-
- Function and control structure opening `{` should be on a separate line.
28-
- Interface and Trait names are suffixed with `Interface` (`FooInterface`) and `Trait` (`FooTrait`) respectively.
3+
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](http://laravel.com/docs/contributions). Please review the entire guide before sending a pull request.

readme.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,17 @@
1010
1111
## Laravel PHP Framework
1212

13-
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as authentication, routing, sessions, and caching.
14-
15-
Laravel aims to make the development process a pleasing one for the developer without sacrificing application functionality. Happy developers make the best code. To this end, we've attempted to combine the very best of what we have seen in other web frameworks, including frameworks implemented in other languages, such as Ruby on Rails, ASP.NET MVC, and Sinatra.
13+
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as authentication, routing, sessions, queueing, and caching.
1614

1715
Laravel is accessible, yet powerful, providing powerful tools needed for large, robust applications. A superb inversion of control container, expressive migration system, and tightly integrated unit testing support give you the tools you need to build any application with which you are tasked.
1816

1917
## Official Documentation
2018

21-
Documentation for the entire framework can be found on the [Laravel website](http://laravel.com/docs).
19+
Documentation for the framework can be found on the [Laravel website](http://laravel.com/docs).
2220

2321
## Contributing
2422

25-
Thank you for considering contributing to the Laravel framework. If you are submitting a bug-fix, or an enhancement that is **not** a breaking change, submit your pull request to the branch corresponding to the latest stable release of the framework, such as the `4.2` branch. If you are submitting a breaking change or an entirely new component, submit your pull request to the `master` branch.
23+
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](http://laravel.com/docs/contributions).
2624

2725
### License
2826

0 commit comments

Comments
 (0)