pypa / pypa/packaging.python.org

I would like to make a better reference page

Open
#724 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

Why

Right now I have been trying to make my first pull request and Its been a nightmare. There is a lot I forgot about since I first creating my GitHub account and howto setup git was one of those things. (even though they do have a good guid and I forgotten it was there ) linking me to the relevant info when I created the account (creating my account was all the time I had at that time). Now I would like to add to the Contribution Guide ( If i ever finish my pull request) and easy this pain for someone else by write what I forgoten about and give them links to relevant info.

One thing i learn from my first pull request Is I need to start with a issue to see how to do this correctly and gain experience from great people like @di and @webknjaz who helped and are help me with my first pull request . I also want a issue to list my problem as I come across them so i can document them better.

What

What I would like to do, if you guys don't have better ideas is to make a page to recommend reading
list and change the cotributing page

Most of the work on the Python Packaging User Guide takes place on the project's GitHub repository. To get started, check out the list of open issues and pull requests. If you're planning to write or edit the guide, please read the :ref:style guide <contributing_style_guide>.

line "list of open issues and pull requests " to "first Contribution page"

Most of the work on the Python Packaging User Guide takes place on the project's GitHub repository. To get started, check out the Contributions Reference page for recommend reading and tips . If you're planning to
write or edit the guide, please read the :ref:style guide <contributing_style_guide>.

here is a draft of that page

The python community understand it can be difficult trying to get started with contribution when you don't know the correct search terms and where to look. To help you in this transition we list some valuable resource were you can learn more for each way you like to contribute.

Bellow are the common method to help with contribute and links to help you get to know and use that method.

Make a new Issue request

Make issue are not to bad but we do have a few recommended reads

mastering issue
mark up

Make a local copy and modify the text

Before you start contributing it is recommend to start with a tutorial and check out the list of open issues and pull requests. Don't forget to make sure have have git configure correctly

and are going to be using locally
do't forget to setup git

Make a pull request

first pull request

etc.

My Questions and comments

After writing this I feel i seen the header like this somewhere else would this be a problem as long as I keep this in my own words?
Is my draft good enough if I keep going?
Do you think I should just make a reference page?

I would like to here what other place people would recommend me add to the list

Thank you for any help.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing Contribution Guide, especially the source/contribute.rst page linked in the issue, and review the proposed reference-page draft and its external links. Done means agreeing on the page scope, adding the recommended contribution resources, and updating the guide’s wording and link consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github, python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.