From 1c7297dc028a6f8d75c109a2321b1879e6bfb367 Mon Sep 17 00:00:00 2001 From: Franz Liedke Date: Wed, 15 Aug 2012 17:33:22 +0300 Subject: [PATCH 1/4] Contrib docs: Remove pointless staging branch info. --- laravel/documentation/contrib/github.md | 1 - 1 file changed, 1 deletion(-) diff --git a/laravel/documentation/contrib/github.md b/laravel/documentation/contrib/github.md index 5d9f43e9..df4980b7 100644 --- a/laravel/documentation/contrib/github.md +++ b/laravel/documentation/contrib/github.md @@ -24,7 +24,6 @@ Laravel's home on GitHub is at [github.com/laravel](https://github.com/laravel). The **laravel** repository has multiple branches, each serving a specific purpose: - **master** - This is the Laravel release branch. Active development does not happen on this branch. This branch is only for the most recent, stable Laravel core code. When you download Laravel from [laravel.com](http://laravel.com/), you are downloading directly from this master branch. *Do not make pull requests to this branch.* -- **staging** - I'm not sure what this is for... Last minute testing before pushing develop to master? - **develop** - This is the working development branch. All proposed code changes and contributions by the community are pulled into this branch. *When you make a pull request to the Laravel project, this is the branch you want to pull-request into.* Once certain milestones have been reached and/or Taylor Otwell and the Laravel team is happy with the stability and additional features of the current development branch, the changes in the **develop** branch are pulled into the **master** branch, thus creating and releasing the newest stable version of Laravel for the world to use. From 67464cb0f80d73fb29e47a05f7f14baa39cb1df8 Mon Sep 17 00:00:00 2001 From: Franz Liedke Date: Wed, 15 Aug 2012 10:45:37 -0400 Subject: [PATCH 2/4] Fix typo in Github page table of contents. --- laravel/documentation/contrib/github.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/laravel/documentation/contrib/github.md b/laravel/documentation/contrib/github.md index df4980b7..4a0f69f4 100644 --- a/laravel/documentation/contrib/github.md +++ b/laravel/documentation/contrib/github.md @@ -3,7 +3,7 @@ ## Contents - [The Basics](#the-basics) -- [Repositories](#repositoriess) +- [Repositories](#repositories) - [Branches](#branches) From f80d694a9500821ad9b1f5ee2f70ba7865a230bb Mon Sep 17 00:00:00 2001 From: Franz Liedke Date: Wed, 15 Aug 2012 10:47:51 -0400 Subject: [PATCH 3/4] Contrib docs: add section stub about pull requests. --- laravel/documentation/contrib/github.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/laravel/documentation/contrib/github.md b/laravel/documentation/contrib/github.md index 4a0f69f4..c8c30daa 100644 --- a/laravel/documentation/contrib/github.md +++ b/laravel/documentation/contrib/github.md @@ -5,20 +5,21 @@ - [The Basics](#the-basics) - [Repositories](#repositories) - [Branches](#branches) +- [Pull Requests](#pull-requests) - + ## The Basics Because Laravel's development and source control is done through GitHub, anyone is able to make contributions to it. Anyone can fix bugs, add features or improve the documentation. After submitting proposed changes to the project, the Laravel team will review the changes and make the decision to commit them to Laravel's core. - + ## Repositories Laravel's home on GitHub is at [github.com/laravel](https://github.com/laravel). Laravel has several repositories. For basic contributions, the only repository you need to pay attention to is the **laravel** repository, located at [github.com/laravel/laravel](https://github.com/laravel/laravel). - + ## Branches The **laravel** repository has multiple branches, each serving a specific purpose: @@ -28,6 +29,11 @@ The **laravel** repository has multiple branches, each serving a specific purpos Once certain milestones have been reached and/or Taylor Otwell and the Laravel team is happy with the stability and additional features of the current development branch, the changes in the **develop** branch are pulled into the **master** branch, thus creating and releasing the newest stable version of Laravel for the world to use. + +## Pull Requests + +Contributing with pull requests. + *Further Reading* - [Contributing to Laravel via Command-Line](docs/contrib/command-line) From 385b776ba812c991678c85d6931833885b62c1d4 Mon Sep 17 00:00:00 2001 From: Franz Liedke Date: Wed, 15 Aug 2012 11:47:27 -0400 Subject: [PATCH 4/4] Docs: Finish section on pull request guidelines. --- laravel/documentation/contrib/github.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/laravel/documentation/contrib/github.md b/laravel/documentation/contrib/github.md index c8c30daa..ceeac76e 100644 --- a/laravel/documentation/contrib/github.md +++ b/laravel/documentation/contrib/github.md @@ -32,7 +32,13 @@ Once certain milestones have been reached and/or Taylor Otwell and the Laravel t ## Pull Requests -Contributing with pull requests. +[GitHub pull requests](https://help.github.com/articles/using-pull-requests) are a great way for everyone in the community to contribute to the Laravel codebase. Found a bug? Just fix it in your fork and submit a pull request. This will then be reviewed, and, if found as good, merged into the main repository. + +In order to keep the codebase clean, stable and at high quality, even with so many people contributing, some guidelines are necessary for high-quality pull requests: + +- **Branch:** Unless they are immediate documentation fixes relevant for old versions, pull requests should be sent to the `develop` branch only. Make sure to select that branch as target when creating the pull request (GitHub will not automatically select it.) +- **Documentation:** If you are adding a new feature or changing the API in any relevant way, this should be documented. The documentation files can be found directly in the core repository. +- **Unit tests:** To keep old bugs from re-appearing and generally hold quality at a high level, the Laravel core is thoroughly unit-tested. Thus, when you create a pull request, it is expected that you unit test any new code you add. For any bug you fix, you should also add regression tests to make sure the bug will never appear again. If you are unsure about how to write tests, the core team or other contributors will gladly help. *Further Reading*