summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2018-05-19 15:12:26 -0700
committerGitHub <noreply@github.com>2018-05-19 15:12:26 -0700
commit227cac0717b6e9c03f88e200efb8dbc35a8a85da (patch)
treec9b79472bd8c7f4473399f220b58523be4a19724
parent26eca6f93aec4125781cdbcb8e4b237d907c0974 (diff)
parentfd65b1fd0175e1346c3d61faf8994ed23ba3906f (diff)
downloadwaitress-contributing.tar.gz
Merge pull request #190 from stevepiercy/contributingcontributing
Update links; unwrap lines
-rw-r--r--contributing.md40
1 files changed, 14 insertions, 26 deletions
diff --git a/contributing.md b/contributing.md
index b163f1e..6bdfb52 100644
--- a/contributing.md
+++ b/contributing.md
@@ -1,16 +1,13 @@
Contributing
============
-All projects under the Pylons Projects, including this one, follow the
-guidelines established at [How to
-Contribute](http://www.pylonsproject.org/community/how-to-contribute) and
-[Coding Style and
-Standards](http://docs.pylonsproject.org/en/latest/community/codestyle.html).
+All projects under the Pylons Projects, including this one, follow the guidelines established at [How to Contribute](https://pylonsproject.org/community-how-to-contribute.html) and [Coding Style and Standards](https://pylonsproject.org/community-coding-style-standards.html).
Get support
-----------
-See [Get Support](http://pylonsproject.org/community-support.html). You are reading this document most likely because you want to *contribute* to the project and not *get support*.
+
+See [Get Support](https://pylonsproject.org/community-support.html). You are reading this document most likely because you want to *contribute* to the project and not *get support*.
Working on issues
@@ -25,13 +22,14 @@ To respect both your time and ours, we emphasize the following points.
Git branches
------------
+
There is a single branch [master](https://github.com/Pylons/waitress/) on which development takes place and from which releases to PyPI are tagged. This is the default branch on GitHub.
Running tests and building documentation
----------------------------------------
-We use [tox](http://tox.readthedocs.io/en/latest/) to automate test running, coverage, and building documentation across all supported Python versions.
+We use [tox](https://tox.readthedocs.io/en/latest/) to automate test running, coverage, and building documentation across all supported Python versions.
To run everything configured in the `tox.ini` file:
@@ -51,13 +49,12 @@ See the `tox.ini` file for details.
Contributing documentation
--------------------------
-*Note:* These instructions might not work for Windows users. Suggestions to
-improve the process for Windows users are welcome by submitting an issue or a
-pull request.
+*Note:* These instructions might not work for Windows users. Suggestions to improve the process for Windows users are welcome by submitting an issue or a pull request.
1. Fork the repo on GitHub by clicking the [Fork] button.
2. Clone your fork into a workspace on your local machine.
+ cd ~/projects
git clone git@github.com:<username>/waitress.git
3. Add a git remote "upstream" for the cloned fork.
@@ -67,10 +64,10 @@ pull request.
4. Set an environment variable to your virtual environment.
# Mac and Linux
- $ export VENV=~/hack-on-waitress/env
+ $ export VENV=~/projects/waitress/env
# Windows
- set VENV=c:\hack-on-waitress\env
+ set VENV=c:\projects\waitress\env
5. Try to build the docs in your workspace.
@@ -80,28 +77,19 @@ pull request.
# Windows
c:\> make clean html SPHINXBUILD=%VENV%\bin\sphinx-build
- If successful, then you can make changes to the documentation. You can
- load the built documentation in the `/_build/html/` directory in a web
- browser.
+ If successful, then you can make changes to the documentation. You can load the built documentation in the `/_build/html/` directory in a web browser.
-6. From this point forward, follow the typical [git
- workflow](https://help.github.com/articles/what-is-a-good-git-workflow/).
- Start by pulling from the upstream to get the most current changes.
+6. From this point forward, follow the typical [git workflow](https://help.github.com/articles/what-is-a-good-git-workflow/). Start by pulling from the upstream to get the most current changes.
git pull upstream master
-7. Make a branch, make changes to the docs, and rebuild them as indicated in
- step 5. To speed up the build process, you can omit `clean` from the above
- command to rebuild only those pages that depend on the files you have
- changed.
+7. Make a branch, make changes to the docs, and rebuild them as indicated in step 5. To speed up the build process, you can omit `clean` from the above command to rebuild only those pages that depend on the files you have changed.
-8. Once you are satisfied with your changes and the documentation builds
- successfully without errors or warnings, then git commit and push them to
- your "origin" repository on GitHub.
+8. Once you are satisfied with your changes and the documentation builds successfully without errors or warnings, then git commit and push them to your "origin" repository on GitHub.
git commit -m "commit message"
git push -u origin --all # first time only, subsequent can be just 'git push'.
9. Create a [pull request](https://help.github.com/articles/using-pull-requests/).
-10. Repeat the process starting from Step 6. \ No newline at end of file
+10. Repeat the process starting from Step 6.