Patchwork contributing: add new file with a pointer to the wiki

login
register
mail settings
Submitter Augie Fackler
Date Oct. 8, 2016, 2:39 p.m.
Message ID <7765e2cea8a778ecafe3.1475937544@augie-macbookair2.roam.corp.google.com>
Download mbox | patch
Permalink /patch/16923/
State Accepted
Headers show

Comments

Augie Fackler - Oct. 8, 2016, 2:39 p.m.
# HG changeset patch
# User Augie Fackler <augie@google.com>
# Date 1475937540 14400
#      Sat Oct 08 10:39:00 2016 -0400
# Node ID 7765e2cea8a778ecafe31b48362f9978bfd961d3
# Parent  87b8e40eb8125d5ddc848d972b117989346057dd
contributing: add new file with a pointer to the wiki

This also includes what I consider to be the minimum set of steps
someone should be able to perform even if they can't run the
testsuite. Hopefully this will help new contributors know to at least
run the two checkers that find most things that (in my experience)
require manual cleanup.
Pierre-Yves David - Oct. 8, 2016, 10:25 p.m.
On 10/08/2016 04:39 PM, Augie Fackler wrote:
> # HG changeset patch
> # User Augie Fackler <augie@google.com>
> # Date 1475937540 14400
> #      Sat Oct 08 10:39:00 2016 -0400
> # Node ID 7765e2cea8a778ecafe31b48362f9978bfd961d3
> # Parent  87b8e40eb8125d5ddc848d972b117989346057dd
> contributing: add new file with a pointer to the wiki

This is great!
Pushed, many thanks.

Patch

diff --git a/CONTRIBUTING b/CONTRIBUTING
new file mode 100644
--- /dev/null
+++ b/CONTRIBUTING
@@ -0,0 +1,13 @@ 
+Our full contribution guidelines are in our wiki, please see:
+
+https://www.mercurial-scm.org/wiki/ContributingChanges
+
+If you just want a checklist to follow, you can go straight to
+
+https://www.mercurial-scm.org/wiki/ContributingChanges#Submission_checklist
+
+If you can't run the entire testsuite for some reason (it can be
+difficult on Windows), please at least run `contrib/check-code.py` on
+any files you've modified and run `python contrib/check-commit` on any
+commits you've made (for example, `python contrib/check-commit
+273ce12ad8f1` will report some style violations on a very old commit).