diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index aaf4e9f..62599f9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -38,25 +38,26 @@ To set up `thelper` for local development: 1. Fork `thelper `_ (look for the "Fork" button). + 2. Clone your fork locally:: - $ git clone git@github.com:your_name_here/thelper.git + $ git clone git@github.com:your_name_here/thelper.git 3. Create a branch for local development:: - $ git checkout -b name-of-your-bugfix-or-feature + $ git checkout -b name-of-your-bugfix-or-feature Now you can make your changes locally. 4. When you're done making changes, run all the checks and doc builder with `tox `_ via:: - $ make test-all + $ make test-all 5. Commit your changes and push your branch to GitHub:: - $ git add . - $ git commit -m "Your detailed description of your changes." - $ git push origin name-of-your-bugfix-or-feature + $ git add . + $ git commit -m "Your detailed description of your changes." + $ git push origin name-of-your-bugfix-or-feature 6. Submit a pull request through the GitHub website. diff --git a/MANIFEST.in b/MANIFEST.in index 44a773e..9dcddd2 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -12,6 +12,7 @@ include .editorconfig include AUTHORS.rst include CHANGELOG.rst include CONTRIBUTING.rst +include DOCUMENTATION.rst include INSTALL.rst include README.rst diff --git a/README.rst b/README.rst index dc3fbc7..e996c3b 100644 --- a/README.rst +++ b/README.rst @@ -60,9 +60,9 @@ For installation instructions, refer to the `installation guide `_. Information about the auto-generated documentation is available `here `_. -===== + Notes -===== +----- Development is still on-going --- expect the API and the internal classes to change rapidly.