Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit89a35bc

Browse files
committed
Adding an official format to be used for documentation pull requests - this follows closely with the new format introduced for the symfony core repository
1 parent1d3a214 commit89a35bc

File tree

3 files changed

+40
-6
lines changed

3 files changed

+40
-6
lines changed

‎CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@ Contributing
22
------------
33

44
We love contributors! For more information on how you can contribute to the
5-
Symfony documentation, please read[Contributing to the Documentation](http://symfony.com/doc/current/contributing/documentation/overview.html)
5+
Symfony documentation, please read[Contributing to the Documentation](http://symfony.com/doc/current/contributing/documentation/overview.html)
6+
and notice the[Pull Request Format](http://symfony.com/doc/current/contributing/documentation/overview.html#pull-request-format)
7+
that helps us merge your pull requests faster!

‎contributing/code/patches.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ pull request message, like in:
264264
[Yaml] fixed something
265265
[Form] [Validator] [FrameworkBundle] added something
266266
267-
The pull request description must include the followingcheck list at the top
267+
The pull request description must include the followingchecklist at the top
268268
to ensure that contributions may be reviewed without needless feedback
269269
loops and that your contributions can be included into Symfony2 as quickly as
270270
possible:

‎contributing/documentation/overview.rst

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,12 @@ Next, create a dedicated branch for your changes (for organization):
4646
4747
You can now make your changes directly to this branch and commit them. When
4848
you're done, push this branch to *your* GitHub fork and initiate a pull request.
49-
The pull request will be between your ``improving_foo_and_bar`` branch and
50-
the ``symfony-docs`` ``master`` branch.
49+
50+
Creating a Pull Request
51+
~~~~~~~~~~~~~~~~~~~~~~~
52+
53+
Following the example, create a pull request will be between your ``improving_foo_and_bar``
54+
branch and the ``symfony-docs`` ``master`` branch.
5155

5256
..image::/images/docs-pull-request.png
5357
:align:center
@@ -60,8 +64,8 @@ the base branch to be 2.0 on the preview page:
6064

6165
..note::
6266

63-
All changes made tothe2.0 branchwill be mergedinto 2.1 which in turn will be
64-
merged into the master branch for the next release on a weekly basis.
67+
All changes made toa branch (e.g.2.0)will be mergedup to each "newer"
68+
branch (e.g. 2.1, master, etc) for the next release on a weekly basis.
6569

6670
GitHub covers the topic of `pull requests`_ in detail.
6771

@@ -70,6 +74,34 @@ GitHub covers the topic of `pull requests`_ in detail.
7074
The Symfony2 documentation is licensed under a Creative Commons
7175
Attribution-Share Alike 3.0 Unported:doc:`License<license>`.
7276

77+
Pull Request Format
78+
~~~~~~~~~~~~~~~~~~~
79+
80+
To ease the core team's work, the pull request description must include the
81+
following checklist to ensure that contributions may be reviewed without
82+
needless feedback loops and that your contributions can be included into
83+
the documentation as quickly as possible:
84+
85+
..code-block::text
86+
87+
| Q | A
88+
| ------------- | ---
89+
| Doc fix? | [yes|no]
90+
| New docs? | [yes|no]
91+
| Applies to | [Symfony version numbers this applies to]
92+
| Fixed tickets | [comma separated list of tickets fixed by the PR]
93+
94+
An example submission could now look as follows:
95+
96+
..code-block::text
97+
98+
| Q | A
99+
| ------------- | ---
100+
| Doc fix? | yes
101+
| New docs? | no
102+
| Applies to | all (or 2.1+)
103+
| Fixed tickets | #1075
104+
73105
..tip::
74106

75107
Please be patient. It can take from 15 minutes to several days for your changes

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp