Skip to content

Commit

Permalink
docs(contributing): rework contributing docs extensively
Browse files Browse the repository at this point in the history
Co-authored-by: Mathieu Kniewallner <[email protected]>
(cherry picked from commit 3f5d483)
  • Loading branch information
neersighted committed Sep 22, 2022
1 parent 2c99ca2 commit 30b9131
Show file tree
Hide file tree
Showing 7 changed files with 185 additions and 453 deletions.
33 changes: 16 additions & 17 deletions .github/ISSUE_TEMPLATE/---bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,25 @@ assignees: ''
---

<!--
Hi there! Thank you for discovering and submitting an issue.
Hi there! Thank you for submitting a bug report!
Before you submit this; let's make sure of a few things.
Please make sure the following boxes are ticked if they are correct.
If not, please try and fulfill these first.
Before you submit your issue, please review and follow the instructions at
https://python-poetry.org/docs/contributing/#reporting-bugs. Fully fill out the template below; insufficient
information or bad reproduction instructions will impair the ability of others to help you.
-->

<!-- Checked checkbox should look like this: [x] -->
- [ ] I am on the [latest](https://github.com/python-poetry/poetry/releases/latest) Poetry version.
- [ ] I have searched the [issues](https://github.com/python-poetry/poetry/issues) of this repo and believe that this is not a duplicate.
- [ ] If an exception occurs when executing a command, I executed it again in debug mode (`-vvv` option).
<!-- All the below information must be provided for others to understand and help with your issue. -->
- **Poetry version**: <!-- Replace with version, e.g. from `poetry --version` -->
- **Python version**: <!-- Replace with the version of Python being used to run Poetry, as reported by `poetry debug info` -->
- **OS version and name**: <!-- Replace with version + name, e.g. Ubuntu 22.04 or macOS 12.6 -->
- **pyproject.toml**: <!-- Replace with a link to a Gist (https://gist.github.com/) containing your sanitized pyproject.toml -->

<!--
Once those are done, if you're able to fill in the following list with your information,
it'd be very helpful to whoever handles the issue.
-->

- **OS version and name**: <!-- Replace with version + name -->
- **Poetry version**: <!-- Replace with version -->
- **Link of a [Gist](https://gist.github.com/) with the contents of your pyproject.toml file**: <!-- Gist Link Here -->
<!-- All the below steps should be completed before submitting your issue. Checked checkbox should look like this: [x] -->
- [ ] I am on the [latest](https://github.com/python-poetry/poetry/releases/latest) stable Poetry version, installed using a recommended method.
- [ ] I have searched the [issues](https://github.com/python-poetry/poetry/issues) of this repo and believe that this is not a duplicate.
- [ ] I have consulted the [FAQ](https://python-poetry.org/docs/faq/) and [blog](https://python-poetry.org/blog/) for any relevant entries or release notes.
- [ ] If an exception occurs when executing a command, I executed it again in debug mode (`-vvv` option) and have included the output below.

## Issue
<!-- Now feel free to write your issue, but please be descriptive! Thanks again 🙌 ❤️ -->
<!-- Now feel free to write your issue, and please be as descriptive as possible! Make sure to include detailed reproduction steps. -->
<!-- Thanks again 🙌 ❤ -->
15 changes: 7 additions & 8 deletions .github/ISSUE_TEMPLATE/---documentation.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
---
name: "\U0001F4DA Documentation"
about: Did you find errors, problems, or anything unintelligible in the docs (https://python-poetry.org/docs)?
name: "\U0001F4DA Documentation Issue"
about: Did you find errors, omissions, or anything unintelligible in the documentation?
title: ''
labels: Documentation, Triage
assignees: ''

---

<!--
Hi there! Thank you for discovering and submitting an issue with our documentation.
Hi there! Thank you for helping improve our documentation!
Before you submit this; let's make sure of a few things.
Please make sure the following boxes are ticked if they are correct.
If not, please try and fulfill these first.
Before you submit your issue, please make sure you have completed the checklist below.
-->

<!-- Checked checkbox should look like this: [x] -->
<!-- All the below steps should be completed before submitting your issue. Checked checkbox should look like this: [x] -->
- [ ] I have searched the [issues](https://github.com/python-poetry/poetry/issues) of this repo and believe that this is not a duplicate.

## Issue
<!-- Now feel free to write your issue, but please be descriptive! Thanks again 🙌 ❤️ -->
<!-- Now feel free to write your issue, and please be as descriptive as possible! -->
<!-- Thanks again 🙌 ❤ -->
16 changes: 8 additions & 8 deletions .github/ISSUE_TEMPLATE/---feature-request.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
name: "\U0001F381 Feature Request"
about: Do you have ideas for new features and improvements?
about: Do you have ideas for new features or improvements?
title: ''
labels: Feature, Triage
assignees: ''

---

<!--
Hi there! Thank you for wanting to make Poetry better.
Hi there! Thank you for submitting a feature request!
Before you submit this; let's make sure of a few things.
Please make sure the following boxes are ticked if they are correct.
If not, please try and fulfill these first.
Before you submit your issue, please review and follow the instructions at
https://python-poetry.org/docs/contributing/#suggesting-enhancements.
-->

<!-- Checked checkbox should look like this: [x] -->
<!-- All the below steps should be completed before submitting your issue. Checked checkbox should look like this: [x] -->
- [ ] I have searched the [issues](https://github.com/python-poetry/poetry/issues) of this repo and believe that this is not a duplicate.
- [ ] I have searched the [documentation](https://python-poetry.org/docs/) and believe that my question is not covered.
- [ ] I have searched the [FAQ](https://python-poetry.org/docs/faq/) and general [documentation](https://python-poetry.org/docs/) and believe that my question is not already covered.

## Feature Request
<!-- Now feel free to write your idea for improvement. Thanks again 🙌 ❤️ -->
<!-- Now feel free to write your issue, and please be as descriptive as possible! -->
<!-- Thanks again 🙌 ❤ -->
8 changes: 6 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: true
blank_issues_enabled: false
contact_links:
- name: '💬 Discussions'
url: https://github.com/python-poetry/poetry/discussions
about: |
Ask questions about using Poetry, Poetry's features and roadmap, or get support and feedback for your usage of Poetry.
- name: '💬 Discord Server'
url: https://discordapp.com/invite/awxPgve
about: |
Chat with the community, ask questions and learn about best practices.
Chat with the community and Poetry maintainers about both the usage of and development of the project.
Loading

0 comments on commit 30b9131

Please sign in to comment.