Meta Issue for Project Opinions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17.7k
- Forks
- 2.3k
- Avg merge
- 1d 30m
- Merged PRs (30d)
- 18
Description
In rewriting the documentation, I have seen a number of opinions that shaped the project. The opinions don't have to do with arbitrary nesting of command, automatic help page generation, or lazy loading of sub commands, and so are really up for discussion. I will try to give reasoning for why that opinion appears to be held. I will also try to give a feature which might be unlocked if we don't hold it. Opinions about parsing behavior will not be discussed because they will be discussed separately at some point in the future.
What I assume to be the POSIX Standards for Utilities that are mentioned in the docs. From a brief look, these are the aimed for standards with backward compatibility taking precedence.
Issues are mostly locked until I get a few more up to give people more concrete examples to look at.
TBD
- #2822
- #2824
Decided
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the documentation opinions described in this issue and review the linked issues #2822 and #2824 for concrete examples. Track which opinions remain open, with parsing behavior handled separately. Done means the relevant opinions have been discussed and the documentation reflects the resulting decisions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100