-
Notifications
You must be signed in to change notification settings - Fork 122
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.
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
Document semantic linefeeds in CONTRIBUTING.rst #500
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,8 +3,7 @@ Contributing to Towncrier | |
|
||
Want to contribute to this project? Great! We'd love to hear from you! | ||
|
||
As a developer and user, you probably have some questions about our | ||
project and how to contribute. | ||
As a developer and user, you probably have some questions about our project and how to contribute. | ||
In this article, we try to answer these and give you some recommendations. | ||
|
||
|
||
|
@@ -36,8 +35,7 @@ There are several options to contribute to this project: | |
|
||
* Modify the code. | ||
|
||
If you would love to see the new feature in the next release, this is | ||
probably the best way. | ||
If you would love to see the new feature in the next release, this is probably the best way. | ||
|
||
|
||
Modifying the code | ||
|
@@ -58,7 +56,6 @@ We recommend the following workflow: | |
|
||
$ git clone [email protected]:GITHUB_USER/towncrier.git | ||
|
||
|
||
#. Prepare a pull request: | ||
|
||
a. Create a new branch with:: | ||
|
@@ -68,10 +65,11 @@ We recommend the following workflow: | |
b. Write your test cases and run the complete test suite, see the section | ||
*Running the test suite* for details. | ||
|
||
|
||
c. Document any user-facing changes in one of the ``/docs/`` files. | ||
Please use `one sentence per line`_. | ||
|
||
d. Create a newsfragment in ``src/towncrier/newsfragments/`` describing the changes and containing information that is of interest to end-users. | ||
Please use `one sentence per line`_ here, too. | ||
|
||
e. Create a `pull request`_. | ||
Describe in the pull request what you did and why. | ||
|
@@ -147,4 +145,5 @@ fails with our dummy test commits. | |
.. _issues: https://github.com/twisted/towncrier/issues | ||
.. _pull request: https://github.com/twisted/towncrier/pulls | ||
.. _nox: https://nox.thea.codes/ | ||
.. _`one sentence per line`: https://rhodesmill.org/brandon/2012/one-sentence-per-line/ | ||
.. _twisted.trial: https://github.com/twisted/trac-wiki-archive/blob/trunk/TwistedTrial.mediawiki |
Empty file.
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.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The URL is named "one sentence per line", but I think that the rule is "one sentence or clause per line".