From bdbf2ce5edc4d973e6f2c2b7a2acf85285918eee Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Fri, 3 Apr 2015 14:47:00 +0100 Subject: [PATCH] Added an initial Contributing guide --- CONTRIBUTING.md | 6 +++++ docs/about/contributing.md | 48 ++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 55 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 docs/about/contributing.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d075545d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +# Contributing to MkDocs + +See the contributing guide in the documentation for an +introduction to contributing to MkDocs. + + http://www.mkdocs.org/about/contributing diff --git a/docs/about/contributing.md b/docs/about/contributing.md new file mode 100644 index 00000000..5797ff36 --- /dev/null +++ b/docs/about/contributing.md @@ -0,0 +1,48 @@ +# Contributing to MkDocs + +An introduction to contributing to the MkDocs project. + +The MkDocs project welcomes, and depends, on contributions from +developers and users in the open source community. Contributions +can be made in a number of ways, a few examples are: + +- Code patches via pull requests +- Documentation improvements +- Bug reports and patch reviews + +## Installing for development + +First you'll need to fork and clone the repository. Once you have +a local copy, run the following command. It is recommended that +you do this within a [virtualenv](virtualenv). + +```no-highlight +pip install --editable . +``` + +This will install MkDocs in development mode which binds the +`mkdocs` command to the git repository. + + +## Running the tests + +To run the tests, it is recommended that you use [Tox](tox). This +just needs to be pip installed and then the test suite can be ran +for MkDocs but running the command `tox` in the root of your +MkDocs repository. + +It will attempt to run the tests against all of the Python +versions we support. So don't be concerned if you are missing +some and they fail. The rest will be verified by [Travis](travis) +when you submit a pull request. + +## Submitting Pull Requests + +Once you are happy with your changes or you are ready for some +feedback, push it to your fork and send a pull request. For a +change to be accepted it will most likely need to have tests and +documentation if it is a new feature. + +[virtualenv]: https://virtualenv.pypa.io/en/latest/userguide.html +[tox]: https://tox.readthedocs.org/en/latest/ +[travis]: https://travis-ci.org/repositories diff --git a/mkdocs.yml b/mkdocs.yml index d74833ca..f456fc19 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,6 +11,7 @@ pages: - ['user-guide/configuration.md', 'User Guide', 'Configuration'] - ['about/license.md', 'About', 'License'] - ['about/release-notes.md', 'About', 'Release Notes'] +- ['about/contributing.md', 'About', 'Contributing'] copyright: Copyright © 2014, Tom Christie. google_analytics: ['UA-27795084-5', 'mkdocs.org']