Skip to content

Commit 0ca4ec2

Browse files
committed
minor symfony#17916 Update contributing docs (nicolas-grekas)
This PR was merged into the 2.3 branch. Discussion ---------- Update contributing docs | Q | A | ------------- | --- | Branch | 2.3 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - I propose adding the branch to the pull request template so that submitters have some hint about the branch selection workflow, and so that we can edit it for mergers. I'd also like to add a link to the "running tests" doc, which made me rewrite the full contributing file, with links to the sections of the contributing documentation. Commits ------- 852f999 Update contributing docs
2 parents d0cac39 + 852f999 commit 0ca4ec2

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
| Q | A
22
| ------------- | ---
3+
| Branch | master for features and deprecations / lowest applicable and maintained version otherwise
34
| Bug fix? | yes/no
45
| New feature? | yes/no
56
| BC breaks? | yes/no

CONTRIBUTING.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,20 @@ Symfony is an open source, community-driven project.
55

66
If you'd like to contribute, please read the following documents:
77

8-
* [Contributing Code][1]: The document index related to contributions;
8+
* [Reporting a Bug][1]
9+
* [Submitting a Patch][2]
10+
* [Symfony Core Team][3]
11+
* [Security Issues][4]
12+
* [Running Symfony Tests][5]
13+
* [Our Backwards Compatibility Promise][6]
14+
* [Coding Standards][7]
15+
* [Conventions][8]
916

10-
* [Submitting a Patch][2]: Guidelines for submitting a pull request;
11-
12-
* [Pull Request Template][3]: Template header to use in your pull request
13-
description;
14-
15-
* [Backwards Compatibility][4]: Backward compatibility rules.
16-
17-
[1]: https://symfony.com/doc/current/contributing/code/index.html
18-
[2]: https://symfony.com/doc/current/contributing/code/patches.html#check-list
19-
[3]: https://symfony.com/doc/current/contributing/code/patches.html#make-a-pull-request
20-
[4]: https://symfony.com/doc/current/contributing/code/bc.html#working-on-symfony-code
17+
[1]: https://symfony.com/doc/current/contributing/code/bugs.html
18+
[2]: https://symfony.com/doc/current/contributing/code/patches.html
19+
[3]: https://symfony.com/doc/current/contributing/code/core_team.html
20+
[4]: https://symfony.com/doc/current/contributing/code/security.html
21+
[5]: https://symfony.com/doc/current/contributing/code/tests.html
22+
[6]: https://symfony.com/doc/current/contributing/code/bc.html
23+
[7]: https://symfony.com/doc/current/contributing/code/standards.html
24+
[8]: https://symfony.com/doc/current/contributing/code/conventions.html

0 commit comments

Comments
 (0)