Skip to content

Commit 6e114b9

Browse files
committed
Improve documentation on contributing [skip ci]
1 parent ba7abf4 commit 6e114b9

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,21 @@ This will also auto add:
101101

102102
1. Fork it ( http://github.com/jekyll/jekyll-compose/fork )
103103
2. Create your feature branch (`git checkout -b my-new-feature`)
104-
3. Run the specs (`script/cibuild`)
104+
3. Run the specs and our linter (`script/cibuild`)
105105
4. Commit your changes (`git commit -am 'Add some feature'`)
106106
5. Push to the branch (`git push origin my-new-feature`)
107107
6. Create new Pull Request
108+
109+
### Submitting a Pull Request based on an existing proposal
110+
111+
When submitting a pull request that uses code from an unmerged pull request, please be aware of the following:
112+
* Changes proposed in the older pull request is still the original author's property. Moving forward from where they left it
113+
means that you're a `co-author`.
114+
* GitHub allows attributing
115+
[credit to multiple authors](https://help.github.com/en/articles/creating-a-commit-with-multiple-authors)
116+
However, pull requests in this project are automatically squashed and then merged onto the base branch. So, only authors and
117+
co-authors of the opening commit gets credit once the pull request gets merged.
118+
* If the original pull request contained multiple commits, you may squash them into a single commit but ensure that you list
119+
any additional authors (and yourselves) as co-authors of that commit.
120+
* Use appropriate [keywords](https://help.github.com/en/articles/closing-issues-using-keywords) in your pull request post to
121+
link to the existing pull request or issue-ticket so that they're automatically closed when your pull request gets merged.

0 commit comments

Comments
 (0)