democritus-project / democritus-project/roadmap
Start a "principles" and/or "best practices" guide
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Values could be:
- Use [sentence case](https://apastyle.apa.org/style-grammar-guidelines/capitalization/sentence-case) for user-facing output
- Be as specific as possible (and no more) when raising an error (e.g. where appropriate, prefer `ValueError` to `Exception`)
(I have more principles in a previous iteration of democritus)
Examples/inspirations:
- https://github.com/best-doctor/guides/blob/master/guides/en/python_styleguide.md
Contributor guide
Research direction
No repository file, test, or entry point is identified. Start by reviewing the proposed values, the previous democritus iteration, and the linked Python style guide; done means adding a principles or best-practices guide with an agreed scope and examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100