Skip to content

Commit cc34618

Browse files
authored
Merge pull request #286 from pryrt/contributingUpdate
CONTRIBUTING.md update
2 parents b567d4f + 2914183 commit cc34618

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

CONTRIBUTION.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ Your pull requests are welcome to suggest changes to the user manual.
1010
* *KISS* - Keep It Simple, Stupid. Fewer changes per PR are better.
1111
* Respect Notepad++ User Manual style.
1212
* It is best if there is an open [issue](/notepad-plus-plus/npp-usermanual/issues) before making changes and submitting a PR, so that you can ask whether your idea is worth incorporating before spending the effort on
13-
* You will need to create a fork to make changes. Create a new branch in your fork for each PR.
13+
* You will need to create a fork to make changes. Create a new branch in your fork for each PR, keeping each PR independent of others you submit.
1414

1515
If these guidelines and style guide are not followed, or if the reviewers otherwise do not believe the submitted changes are appropriate, you may be asked to make changes to your PR, or your PR may be rejected. If you do not make requested changes, the reviewers may edit or reject the PR. We reserve the right to reject a PR for any reason, not just for a reason explicitly enumerated in this document.
1616

1717
## Style Guide
1818

19-
* First and foremost, when editing, keep it similar to what's already in that document.
19+
* First and foremost, when editing, keep it similar to what's already in that document.
20+
* Do not arbitrarily change an existing style choice (like `-` vs `*` for bulleted lists, or `_..._` vs `*...*` for italics) without a good technical reason
21+
* If you are fixing an actual Markdown _error_ that causes the final user manual documentation to render incorrectly, that is allowed (and encouraged).
2022

2123
* When referencing a menu item, like **File > Open**, make it bold, and use `>` as the separator-character between different levels. <!-- This follows Microsoft documentation style for the separator character, so will make it more familiar to Windows users. -->
2224

@@ -30,10 +32,26 @@ If these guidelines and style guide are not followed, or if the reviewers otherw
3032

3133
* Images should be used sparingly. If they are needed, keep the filesize small and place the image file in the `content/docs/images/` directory.
3234

35+
* Changes to the theme (whether it's just slight edits or a completely new theme, or anything in between) will not be accepted unless you have worked with the owner to make sure that the changes to the theme are necessary or appropriate.
36+
3337
## Cross-Links
3438

3539
* To link from one page in the user-manual docs to the top of another page, use the syntax `[link name](../page/)` . *Note* that in the link syntax, `page` does _not_ include the `.md` extension.
3640

3741
* To link to an anchor (like a heading) in another file, use `[link name](../page/#anchor)` ; or use `[link name](#anchor)` to link to an anchor (heading) in the same file. The anchor names are the lower-case version of the section headers, with spaces replaced by hyphens.
3842

3943
* Example: from the [Themes](content/docs/themes/) page, you can link to the [**Preferences > Style Configurator**](content/docs/preferences/#style-configurator) using the syntax `[**Preferences > Style Configurator**](../preferences/#style-configurator)`.
44+
45+
## Keep PRs independent
46+
47+
If you are making multiple PRs, please make sure you keep them separate. If you make a first change to change A to B and submit it as PR #N, then using the same branch (or a new branch that started from the first branch) and change C to D and submit as PR #M, then PR #M will contain the same changes as #N, in addition to the new changes. This will mean that if #N is rejected, #M will likely be rejected as well (because they contain the same changes that were rejected); and if #N is accepted (possibly with changes from the maintainers), then #M might come in conflict with #N; this also makes it harder to evaluate specifically what was intended for PR #M.
48+
49+
The best way to avoid this problem is to
50+
1. Fork from the main repository, or sync your existing fork with the main repository using GitHub's **Fetch Upstream > Fetch and Merge** feature
51+
2. Before making any new changes, create a branch specific to the one issue you are trying to fix
52+
3. Make those changes and submit a new PR from the _branch_ back to the main repository
53+
4. If you want to make changes for another issue before the PR from step#3 was accepted and merged, create a new branch from your unmodified fork, so that it's starting from the same state that the main repository is currently in
54+
5. Make the changes in the new branch, and submit a PR from that branch to the main repository
55+
6. Now your PRs from #3 and #5 are independent, and #5 won't repeat or interfere with the changes from #3
56+
57+
If PRs are not kept independent, they may be rejected.

0 commit comments

Comments
 (0)