Merge pull request #3362 from Pylons/docs-prep-style-guide

Michael Merickel

2018-10-04 a3c9a003ff05fa3ce10f6912e6828194262c7b6c

Merge pull request #3362 from Pylons/docs-prep-style-guide

Docs prep style guide

 .github/ISSUE_TEMPLATE/bug_report.md

New file
@@ -0,0 +1,31 @@
---
name: Bug Report
about: Create a report to help us improve

---

## Get Support
To get help or technical support, see [Get Support](https://pylonsproject.org/community-support.html).

## Bug Report

Please [search the issue tracker](https://github.com/Pylons/pyramid/issues) for similar issues before submitting a new issue.

**Describe the bug**
A clear and concise description of the bug.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain the issue.

**Additional context**
Add any other context about the issue here.

 .github/ISSUE_TEMPLATE/documentation.md

New file
@@ -0,0 +1,29 @@
---
name: Documentation Suggestion
about: Create an issue to improve our documentation

---

## Get Support
To get help or technical support, see [Get Support](https://pylonsproject.org/community-support.html).

## Documentation Suggestion

Please [search the issue tracker](https://github.com/Pylons/pyramid/issues) for similar issues before submitting a new issue.

**Describe the issue**
A clear and concise description of the issue.

**Include references**
1. Go to the URL '...'
2. Click on '....'
3. Scroll down to '....'

**Describe the improvement**
A clear and concise description of your suggestion.

**Screenshots**
If applicable, add screenshots to help explain the issue.

**Additional context**
Add any other context about the issue here.

 .github/ISSUE_TEMPLATE/feature_request.md

New file
@@ -0,0 +1,24 @@
---
name: Feature Request
about: Suggest an idea for this project

---

## Get Support
To get help or technical support, see [Get Support](https://pylonsproject.org/community-support.html).

## Feature Request

Please [search the issue tracker](https://github.com/Pylons/pyramid/issues) for similar issues before submitting a new issue.

**Is your feature request related to an issue? Please describe.**
A clear and concise description of the issue. Example: "I'm always frustrated when [...]".

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

 MANIFEST.in

@@ -8,9 +8,11 @@

include contributing.md RELEASING.txt
include tox.ini appveyor.yml .travis.yml rtd.txt
graft .github

include HACKING.txt hacking-tox.ini
include builddocs.sh coverage.sh scaffoldtests.sh
include TODO.txt

global-exclude __pycache__ *.py[cod]
global-exclude .DS_Store

 contributing.md

@@ -1,28 +1,16 @@
Contributing
============
# Contributing

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).
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), [Coding Style and Standards](https://pylonsproject.org/community-coding-style-standards.html), and [Pylons Project Documentation Style Guide](https://docs.pylonsproject.org/projects/docs-style-guide/).

You can contribute to this project in several ways.

* [File an Issue on GitHub](https://github.com/Pylons/pyramid/issues)
* Fork this project and create a branch with your suggested change. When ready,
  submit a pull request for consideration. [GitHub
  Flow](https://guides.github.com/introduction/flow/index.html) describes the
  workflow process and why it's a good practice. When submitting a pull
  request, sign
  [CONTRIBUTORS.txt](https://github.com/Pylons/pyramid/blob/master/CONTRIBUTORS.txt)
  if you have not yet done so.
* Join the IRC channel #pyramid on irc.freenode.net.
* Fork this project and create a branch with your suggested change. When ready, submit a pull request for consideration. [GitHub Flow](https://guides.github.com/introduction/flow/index.html) describes the workflow process and why it's a good practice. When submitting a pull request, sign [CONTRIBUTORS.txt](https://github.com/Pylons/pyramid/blob/master/CONTRIBUTORS.txt) if you have not yet done so.
* Join the [IRC channel #pyramid on irc.freenode.net](https://webchat.freenode.net/?channels=pyramid).

Git Branches
------------
Git branches and their purpose and status at the time of this writing are
listed below.
## Git Branches

Git branches and their purpose and status at the time of this writing are listed below.

* [master](https://github.com/Pylons/pyramid/) - The branch on which further
  development takes place. The default branch on GitHub.
@@ -34,16 +22,14 @@
Older branches are not actively maintained. In general, two stable branches and
one or two development branches are actively maintained.

Prerequisites
-------------
## Prerequisites

Follow the instructions in HACKING.txt for your version or branch located in
the [root of the Pyramid repository](https://github.com/Pylons/pyramid/) to
install Pyramid and the tools needed to run its tests and build its
documentation.

Building documentation for a Pylons Project project
---------------------------------------------------
## Building documentation for a Pylons Project project

*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