From 456d0fdfd5da7b9700f869c7738be3c3a506cd42 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 21 Sep 2018 20:05:40 -0700 Subject: Standardize contributing.md - Add link to new PP Docs Style Guide - Add link to #pyramid on IRC - Use standard markdown syntax --- contributing.md | 34 ++++++++++------------------------ 1 file changed, 10 insertions(+), 24 deletions(-) diff --git a/contributing.md b/contributing.md index 3b960c1e1..40c42add7 100644 --- a/contributing.md +++ b/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. - -Git Branches ------------- -Git branches and their purpose and status at the time of this writing are -listed below. +* 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. * [master](https://github.com/Pylons/pyramid/) - The branch on which further development takes place. The default branch on GitHub. @@ -34,16 +22,14 @@ listed below. 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 -- cgit v1.2.3 From 26e1afe6ba1986e420c67fc47e7110b90dc308f6 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 21 Sep 2018 20:44:57 -0700 Subject: Add issue templates, first draft. --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 29 +++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 ++++++++++++++++++++++++ 3 files changed, 84 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..d6ab170f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 000000000..1117a57aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..f71d6b24e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. -- cgit v1.2.3 From d6e6a79deddd01ce4bcedb01a9edb6303d21c31d Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 21 Sep 2018 20:59:32 -0700 Subject: ignore .github from sdist --- setup.cfg | 2 ++ 1 file changed, 2 insertions(+) diff --git a/setup.cfg b/setup.cfg index 3bf28ee15..ca82253b5 100644 --- a/setup.cfg +++ b/setup.cfg @@ -69,6 +69,8 @@ show-source = True [check-manifest] ignore = + .github + .github/* .gitignore PKG-INFO *.egg-info -- cgit v1.2.3 From a31456c0206bf2395e17f26fc3dd4e6e6b49901b Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 2 Oct 2018 22:04:51 -0700 Subject: Shuffle .github .github/* from setup.cfg to MANIFEST.in --- MANIFEST.in | 2 ++ setup.cfg | 2 -- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index 2e18ad5fe..7371479f8 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -13,4 +13,6 @@ include HACKING.txt hacking-tox.ini include builddocs.sh coverage.sh scaffoldtests.sh include TODO.txt +include .github .github/* + global-exclude __pycache__ *.py[cod] diff --git a/setup.cfg b/setup.cfg index ca82253b5..3bf28ee15 100644 --- a/setup.cfg +++ b/setup.cfg @@ -69,8 +69,6 @@ show-source = True [check-manifest] ignore = - .github - .github/* .gitignore PKG-INFO *.egg-info -- cgit v1.2.3 From 4c0e7f76572d8d2332c3a0e01312fdb7c5def382 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 2 Oct 2018 22:30:32 -0700 Subject: Is this "graft"? --- MANIFEST.in | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/MANIFEST.in b/MANIFEST.in index 7371479f8..8b2aff2ae 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -13,6 +13,8 @@ include HACKING.txt hacking-tox.ini include builddocs.sh coverage.sh scaffoldtests.sh include TODO.txt -include .github .github/* +include .github .github/ISSUE_TEMPLATE .github/ISSUE_TEMPLATE/bug_report.md +include .github/ISSUE_TEMPLATE/documentation.md +include .github/ISSUE_TEMPLATE/feature_request.md global-exclude __pycache__ *.py[cod] -- cgit v1.2.3 From 93067a729a3d25c428a9a356eaad801badf6f6a1 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 2 Oct 2018 22:49:24 -0700 Subject: So that's what graft means --- MANIFEST.in | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index 8b2aff2ae..b47e12cc9 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,7 @@ graft pyramid graft docs prune docs/_build +graft .github include README.rst include CHANGES.rst HISTORY.rst BFG_HISTORY.rst @@ -13,8 +14,4 @@ include HACKING.txt hacking-tox.ini include builddocs.sh coverage.sh scaffoldtests.sh include TODO.txt -include .github .github/ISSUE_TEMPLATE .github/ISSUE_TEMPLATE/bug_report.md -include .github/ISSUE_TEMPLATE/documentation.md -include .github/ISSUE_TEMPLATE/feature_request.md - global-exclude __pycache__ *.py[cod] -- cgit v1.2.3 From 899393ea137564a454a752584ac5594a0a1d3cc0 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 2 Oct 2018 22:55:14 -0700 Subject: recursive-exclude all .DS_Store files --- MANIFEST.in | 2 ++ 1 file changed, 2 insertions(+) diff --git a/MANIFEST.in b/MANIFEST.in index b47e12cc9..813ca4b9c 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -15,3 +15,5 @@ include builddocs.sh coverage.sh scaffoldtests.sh include TODO.txt global-exclude __pycache__ *.py[cod] +recursive-exclude docs .DS_Store +recursive-exclude pyramid .DS_Store -- cgit v1.2.3 From 3ef18d1ccff612859fd8eb96888bfb2ac9659a74 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 2 Oct 2018 22:59:09 -0700 Subject: nah, just exclude all .DS_Store files, and delete a stray directory --- MANIFEST.in | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index 813ca4b9c..71f9ea3d2 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -15,5 +15,4 @@ include builddocs.sh coverage.sh scaffoldtests.sh include TODO.txt global-exclude __pycache__ *.py[cod] -recursive-exclude docs .DS_Store -recursive-exclude pyramid .DS_Store +exclude .DS_Store -- cgit v1.2.3 From 6d7636144e57fb804e4d6e5c3596c7421c051542 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 3 Oct 2018 13:22:38 -0700 Subject: spit and polish --- MANIFEST.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index 71f9ea3d2..c3391cbcc 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,7 +1,6 @@ graft pyramid graft docs prune docs/_build -graft .github include README.rst include CHANGES.rst HISTORY.rst BFG_HISTORY.rst @@ -9,10 +8,11 @@ include CONTRIBUTORS.txt LICENSE.txt COPYRIGHT.txt 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] -exclude .DS_Store +global-exclude .DS_Store -- cgit v1.2.3