Tweak the PR check-list and add more information about how to contribute #2137
Conversation
| | Bug fix? | [yes|no] | ||
| | New feature? | [yes|no] | ||
| | BC breaks? | [yes|no] | ||
| | Deprecations? | [yes|no] |
There was a problem hiding this comment.
The when must be documented in the CHANGELOG and/or the UPGRADE file anyway.
|
I've just added a shorter version of the todo-list for minor changes. |
|
@fabpot should we list the deprecations ? The goal being to help search the issue tracker when we face an issue. |
|
@vicb As I commented above, deprecations (like BC breaks) must be part of the diff. |
|
The check-list is a quick way to see what the PR is about and to be sure that the developer submitting it thought about those concerns. |
|
@vicb I've just added some more information about deprecations and BC breaks in the third commit. |
|
@vicb: Instead, I have just added a new section with actions you must do depending on your answers (see d487976). |
|
@fabpot The new section is really nice by I don't expect devs to monitor this files for changes, that's why I think it would be good to also add some hints to the summary. |
|
@fabpot Are you still -1 on adding a list of known issues |
| * If you answer no to "Tests pass", you must add an item to a todo-list with | ||
| the actions that must be done to fix the tests; | ||
|
|
||
| * If you the "license" is not MIT, just don't submit the pull request as it |
There was a problem hiding this comment.
the word "you" needs to be removed here
|
@vicb I've never been -1 on adding a list of known issues, but whenever possible I'd rather add the checks in the requirements file. |
|
|
||
| .. code-block:: text | ||
|
|
||
| - [ ] fixed the tests as they have not been updated yet |
There was a problem hiding this comment.
i think "fixed" should be "fix" here as it's to-do
|
If we agree on the content of this PR, and when it's merged, I will write a blog post about these changes. Then, we will probably need some people to help triage the PR and ask submitters to follow our guidelines. |
|
@fabpot glad to hear that. The requirements file is part of the SE so doing both is probably the best solution ? |
|
@fabpot plus some things don't belong to the requirements (ie limitations in the Form component, double decoding of URLs, ...) |
|
@vicb: Let's not hijack this PR. Let's start a PR with a new KNOWN_ISSUES file. |
|
@weaverryan Should be ready to merge now. |
Tweak the PR check-list and add more information about how to contribute
|
Thanks - merged in, and up to 2.1 and master - it's ready for the world! :) |
I've updated the PR check-list to make it more readable. That should also help the review process as spotting BC breaks for instance or any other information should be easier and faster.
I've also added a small tip about how to create a todo-list on Github.
You see the new check-list in action here:
symfony/symfony#6738
ping @vicb