saltstack / saltstack/relenv

Better documentation of runtime bootstrap

Open
#154 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
38
Forks
23
Avg merge
2h 48m
Merged PRs (30d)
5

Description

There should be better documentation about all of the things relenv does when python starts up.

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

Start by tracing relenv's Python startup and runtime bootstrap flow, since the issue names no files or entry points. Document each action relenv performs when Python starts; done means the documentation comprehensively explains that startup behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.