10000 [WIP] Patch check list by lsmith77 · Pull Request #725 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[WIP] Patch check list #725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 23, 2011
Merged

[WIP] Patch check list #725

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e92c57d
added a check list for pull request submissions
lsmith77 Sep 23, 2011
ba55af9
tweaked text on BC breaks
lsmith77 Sep 23, 2011
6fd71e0
removed description from the checklist
lsmith77 Sep 23, 2011
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions contributing/code/patches.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,46 @@ Submitting a Patch
Patches are the best way to provide a bug fix or to propose enhancements to
Symfony2.

Check List
----------

The purpose of the check list is to ensure that contributions may be reviewed
with needless feedback loops to ensure that your contributions can be included
into Symfony2 as quickly as possible.

.. warning::

All pull requests should include the following template in the request
description:

.. code-block:: plain

Bug fix: [yes|no]
Feature addition: [yes|no]
Backwards compatibility break: [yes|no]
Symfony2 tests pass: [yes|no]
Fixes the following tickets: [comma separated list of tickets fixed by the PR]

An example submission could now look as follows:

.. code-block:: plain

Bug fix: no
Feature addition: yes
Backwards compatibility break: no
Symfony2 tests pass: yes
Fixes the following tickets: -

Thank you for including the filled out template in your submission!

.. tip::

All feature addition's should be send to the "master" branch, while all
bug fixes should be send to the oldest still active branch. Furthermore
submissions should as a rule of thumb not break backwards compatibility.
Please mark any submissions as "[WIP]" in the title in case the submission
is not yet complete (for example if the tests do not yet pass).

Initial Setup
-------------

Expand Down
0