saltstack / saltstack/salt

[DOCS] Update pyenv instructions in CONTRIBUTING guide

Open
#64,216 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

community-docs documentation severity-medium time-estimate-sprint
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

The pyenv instructions in our Contributing guide are out of date with the latest pyenv instructions at: https://github.com/pyenv/pyenv#set-up-your-shell-environment-for-pyenv

We should update and future-proof the Contributing guide by just linking out to the pyenv instructions.

Contributor guide

Open the contributing guide

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

Open the CONTRIBUTING guide and locate its current pyenv instructions; compare them with the linked pyenv shell-environment instructions. Done means the outdated instructions are replaced with a link to the official pyenv guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.