Skip to content

Tweak the PR check-list and add more information about how to contribute #2137

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 4 commits into from
Jan 17, 2013
Merged

Tweak the PR check-list and add more information about how to contribute #2137

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f28e123
tweaked the PR check-list to make it more readable
fabpot Jan 15, 2013
4f4c0c3
added a shorter version of the todo list for minor changes
fabpot Jan 15, 2013
1666468
added more information about how to document BC breaks and deprecations
fabpot Jan 15, 2013
ea65196
added more hints about the goals of the check-list
fabpot Jan 15, 2013
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
44 changes: 27 additions & 17 deletions contributing/code/patches.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,35 +265,45 @@ pull request message, like in:
.. tip::

Please use the title with "[WIP]" if the submission is not yet completed
or the tests are incomplete or not yet passing.
or the tests are incomplete or not yet passing. Also add a todo-list in
the pull-request description describing what still need to be done:

.. code-block:: text

- [ ] tests need to be updated
- [ ] documentation PR yet to be submitted

The pull request description must include the following check list to ensure
that contributions may be reviewed without needless feedback loops and that
your contributions can be included into Symfony2 as quickly as possible:

.. code-block:: text

Bug fix: [yes|no]
Feature addition: [yes|no]
Backwards compatibility break: [yes|no]
Deprecations: [what, when|no]
Symfony2 tests pass: [yes|no]
Fixes the following tickets: [comma separated list of tickets fixed by the PR]
Todo: [list of todos pending]
License of the code: MIT
Documentation PR: [The reference to the documentation PR if any]
| Q | A
| ------------- | ---
| Bug fix? | [yes|no]
| New feature? | [yes|no]
| BC breaks? | [yes|no]
| Deprecations? | [yes|no]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about [yes, when|no]

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The when must be documented in the CHANGELOG and/or the UPGRADE file anyway.

| Tests pass? | [yes|no]
| Fixed tickets | [comma separated list of tickets fixed by the PR]
| License | MIT
| Doc PR | [The reference to the documentation PR if any]

An example submission could now look as follows:

.. code-block:: text

Bug fix: no
Feature addition: yes
Backwards compatibility break: no
Fixes the following tickets: #12, #43
Todo: -
License of the code: MIT
Documentation PR: symfony/symfony-docs#123
| Q | A
| ------------- | ---
| Bug fix? | no
| New feature? | no
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets | #12, #43
| License | MIT
| Doc PR | symfony/symfony-docs#123

In the pull request description, give as much details as possible about your
changes (don't hesitate to give code examples to illustrate your points). If
Expand Down