[MRG+1] Encourage complete titles in pull requests #2026
Merged
Conversation
docs/contributing.rst
Outdated
| @@ -100,6 +100,11 @@ starting point is to send a pull request on GitHub. It can be simple enough to | |||
| illustrate your idea, and leave documentation/tests for later, after the idea | |||
| has been validated and proven useful. Alternatively, you can send an email to | |||
| `scrapy-users`_ to discuss your idea first. | |||
| When writting GitHub pull requests, try to keep titles short but descriptive. | |||
nyov
Jul 2, 2016
Contributor
s/writting/writing/
s/writting/writing/
Digenis
force-pushed the
Digenis:contributing-full_subjects
branch
from
974f951
to
2a92ffb
Current coverage is 83.33%
|
eliasdorneles
changed the title
redapple
added a commit
that referenced
this pull request
Jul 8, 2016
[backport][1.1] Encourage descriptive PR titles (PR #2026)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Linking to an issue when creating a PR is useful
but authors sometimes replace the whole subject with "Fix+tests for #000"
which makes it hard to skim through the issue tracker or its feed
especially when the description is missing from the PR itself.
This is even more important for commit messages.
With this pr I want to open the discussion;
I'm not fully convinced that this is the role of the documentation
but I wrote it there as a start.