summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAdam J. Stewart <ajstewart426@gmail.com>2016-10-14 11:16:13 -0500
committerTodd Gamblin <tgamblin@llnl.gov>2016-10-14 09:16:13 -0700
commit78d3c7e2a28069b9099f9d621e785f23b4e44359 (patch)
tree12330fca7f6608ff00e09016f5b089c12f6ec9c7 /README.md
parent0d89e5e32b120fc36317240eacdb4fbb55e6425c (diff)
downloadspack-78d3c7e2a28069b9099f9d621e785f23b4e44359.tar.gz
spack-78d3c7e2a28069b9099f9d621e785f23b4e44359.tar.bz2
spack-78d3c7e2a28069b9099f9d621e785f23b4e44359.tar.xz
spack-78d3c7e2a28069b9099f9d621e785f23b4e44359.zip
Major updates to Contribution Guide (#1968)
* Major updates to Contribution Guide * Grammar changes * Fix missing/extra backticks * Rewording, links, and tips added
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 4 insertions, 10 deletions
diff --git a/README.md b/README.md
index ec2da3934e..853e071fc6 100644
--- a/README.md
+++ b/README.md
@@ -63,17 +63,11 @@ Contributing to Spack is relatively easy. Just send us a
When you send your request, make ``develop`` the destination branch on the
[Spack repository](https://github.com/LLNL/spack).
-Before you send a PR, your code should pass the following checks:
-
-* Your contribution will need to pass the `spack test` command.
- Run this before submitting your PR.
-
-* Also run the `share/spack/qa/run-flake8-tests` script to check for PEP8 compliance.
- To encourage contributions and readability by a broad audience,
- Spack uses the [PEP8](https://www.python.org/dev/peps/pep-0008/) coding
- standard with [a few exceptions](https://github.com/LLNL/spack/blob/develop/.flake8).
-
+Your PR must pass Spack's unit tests and documentation tests, and must be
+[PEP 8](https://www.python.org/dev/peps/pep-0008/) compliant.
We enforce these guidelines with [Travis CI](https://travis-ci.org/LLNL/spack).
+To run these tests locally, and for helpful tips on git, see our
+[Contribution Guide](http://spack.readthedocs.io/en/latest/contribution_guide.html).
Spack uses a rough approximation of the [Git
Flow](http://nvie.com/posts/a-successful-git-branching-model/)