Skip to content

Commit babba21

Browse files
authored
(#8716) - update Committer guidelines
Co-authored-by: alxndrsn <alxndrsn>
1 parent 171f80e commit babba21

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -136,24 +136,23 @@ Committers!
136136

137137
With great power comes great responsibility yada yada yada:
138138

139-
* Code is peer reviewed, you should (almost) never push your own code.
140-
* Please don't accidentally force push to master.
141-
* Cherry Pick / Rebase commits, **don't use the big green button**, see below for instructions on how to
139+
* Code is peer reviewed, you should not merge un-reviewed code.
140+
* Pushing to `master` is blocked by GitHub.
141+
* Cherry Pick / Rebase commits, **don't use merge commits**, see below for instructions on how to
142142
merge a pull request.
143143
* Ensure reviewed code follows the above contribution guidelines, if it doesn't feel free to amend and make note.
144144
* Please try to watch when Pull Requests are made and review and / or commit them in a timely manner.
145145
* After you merge in a patch use tin to update the version accordingly. Run `tin -v x.x.x-prerelease` with x.x.x being the previous version upgraded appropriately via semver. When we are ready to publish to npm we can remove the `-prerelease`.
146146
* Thanks, you are all awesome human beings.
147147

148148
**How to merge a pull request**
149-
* Go to the pouchdb repository on your machine
150-
* Get the link to the patch of the pull request, which can be found under 'view command line instructions'
151-
next to the green 'Merge pull request' button on the page on GitHub for the pull request
152-
* In your command line, run the following:
153-
* `curl https://patch-diff.githubusercontent.com/raw/pouchdb/pouchdb/pull/[PATCH NUMBER].patch | git am - && git push origin master`, replacing [PATCH NUMBER] with the number of the patch you want to merge.
154-
* Close the pull request once it has been merged, so no-one accidentally tries to merge it themselves
155-
* Make sure the issue associated with the pull request is closed, if the issue was resolved by that pull
156-
request
149+
* Use the github Pull Request UI.
150+
* Generally, use _Squash and merge_.
151+
* In special circumstances, _Rebase and merge_ may be used. It may be appropriate where intermediate commits in a pull request:
152+
* meet standard requirements for commit messages; and
153+
* are important for future understanding of a sequence of related changes; and
154+
* cannot be broken down into separate pull requests.
155+
* Make sure the issue associated with the pull request is closed, if the issue was resolved by that pull request.
157156

158157
Release Procedure
159158
-----------------

0 commit comments

Comments
 (0)