Commit 3f5d4831 by Bjorn Neergaard

docs(contributing): rework contributing docs extensively

Co-authored-by: Mathieu Kniewallner <mathieu.kniewallner@gmail.com>
parent 16725163
...@@ -8,26 +8,25 @@ assignees: '' ...@@ -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. Before you submit your issue, please review and follow the instructions at
Please make sure the following boxes are ticked if they are correct. https://python-poetry.org/docs/contributing/#reporting-bugs. Fully fill out the template below; insufficient
If not, please try and fulfill these first. information or bad reproduction instructions will impair the ability of others to help you.
--> -->
<!-- Checked checkbox should look like this: [x] --> <!-- All the below information must be provided for others to understand and help with your issue. -->
- [ ] I am on the [latest](https://github.com/python-poetry/poetry/releases/latest) Poetry version. - **Poetry version**: <!-- Replace with version, e.g. from `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. - **Python version**: <!-- Replace with the version of Python being used to run Poetry, as reported by `poetry debug info` -->
- [ ] If an exception occurs when executing a command, I executed it again in debug mode (`-vvv` option). - **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 -->
<!-- <!-- All the below steps should be completed before submitting your issue. Checked checkbox should look like this: [x] -->
Once those are done, if you're able to fill in the following list with your information, - [ ] I am on the [latest](https://github.com/python-poetry/poetry/releases/latest) stable Poetry version, installed using a recommended method.
it'd be very helpful to whoever handles the issue. - [ ] 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.
- **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 -->
## Issue ## 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 🙌 ❤ -->
--- ---
name: "\U0001F4DA Documentation" name: "\U0001F4DA Documentation Issue"
about: Did you find errors, problems, or anything unintelligible in the docs (https://python-poetry.org/docs)? about: Did you find errors, omissions, or anything unintelligible in the documentation?
title: '' title: ''
labels: area/docs, status/triage labels: area/docs, status/triage
assignees: '' assignees: ''
...@@ -8,15 +8,14 @@ assignees: '' ...@@ -8,15 +8,14 @@ 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. Before you submit your issue, please make sure you have completed the checklist below.
Please make sure the following boxes are ticked if they are correct.
If not, please try and fulfill these first.
--> -->
<!-- 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 [issues](https://github.com/python-poetry/poetry/issues) of this repo and believe that this is not a duplicate.
## Issue ## 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 🙌 ❤ -->
--- ---
name: "\U0001F381 Feature Request" 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: '' title: ''
labels: kind/feature, status/triage labels: kind/feature, status/triage
assignees: '' assignees: ''
...@@ -8,16 +8,16 @@ assignees: '' ...@@ -8,16 +8,16 @@ 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. Before you submit your issue, please review and follow the instructions at
Please make sure the following boxes are ticked if they are correct. https://python-poetry.org/docs/contributing/#suggesting-enhancements.
If not, please try and fulfill these first.
--> -->
<!-- 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 [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 ## 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 🙌 ❤ -->
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser # 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: 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' - name: '💬 Discord Server'
url: https://discordapp.com/invite/awxPgve url: https://discordapp.com/invite/awxPgve
about: | 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.
...@@ -100,16 +100,16 @@ It will automatically find a suitable version constraint **and install** the pac ...@@ -100,16 +100,16 @@ It will automatically find a suitable version constraint **and install** the pac
Poetry supports a rich [dependency specification]({{< relref "dependency-specification" >}}) syntax, including caret, Poetry supports a rich [dependency specification]({{< relref "dependency-specification" >}}) syntax, including caret,
tilde, wildcard, inequality and tilde, wildcard, inequality and
[multiple constraint]({{< relref "dependency-specification#multiple-constraints-dependencies" >}}) requirements. [multiple constraints]({{< relref "dependency-specification#multiple-constraints-dependencies" >}}) requirements.
## Using your virtual environment ## Using your virtual environment
By default, poetry creates a virtual environment in `{cache-dir}/virtualenvs`. By default, Poetry creates a virtual environment in `{cache-dir}/virtualenvs`.
You can change the [`cache-dir`]({{< relref "configuration#cache-dir" >}} "cache-dir configuration documentation") value You can change the [`cache-dir`]({{< relref "configuration#cache-dir" >}} "cache-dir configuration documentation") value
by editing the Poetry config. by editing the Poetry configuration.
Additionally, you can use the Additionally, you can use the
[`virtualenvs.in-project`]({{< relref "configuration#virtualenvsin-project" >}}) configuration variable to create [`virtualenvs.in-project`]({{< relref "configuration#virtualenvsin-project" >}}) configuration variable to create
virtual environment within your project directory. virtual environments within your project directory.
There are several ways to run commands within this virtual environment. There are several ways to run commands within this virtual environment.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment