saltstack / saltstack/salt

[BUG][DOCS] Contributing docs have old RFC references to be removed and add details about SEP process

Open
#57,988 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug doc-rework documentation severity-medium time-estimate-single-day
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
The RFC process was replaced with Enhancement Proposal process, first mentioned here: https://github.com/saltstack/salt-enhancement-proposals/pull/1#issuecomment-468823572

Maybe in more places in the docs: https://docs.saltstack.com/en/latest/topics/development/contributing.html#new-features

SEP repo https://github.com/saltstack/salt-enhancement-proposals
and readme file link for ease of use

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 with the New Features section of docs.saltstack.com/en/latest/topics/development/contributing.html and search the surrounding documentation for RFC references. Read the salt-enhancement-proposals README to confirm the current SEP process, then remove obsolete references and add the SEP details and repository link.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.