Establish Python development guidelines
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 3
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Taken from a suggestion in https://github.com/RMI/opgee-highlander/pull/24. It could be beneficial to establish a broad set of guidelines to inform the python development process. The same could be done for other languages or project types.
Where
Propose adding new guidelines or docs folder.
Language specific docs can reside in relevant sub-folder: docs/python or guidelines/python
Contents
- style guidelines
- common/recommended tooling
- architectural/design guidance
- recommended packages for various needs (e.g. "data manipulation" ->
polars, db connectivity ->psycopg3orasyncpg, etc...) - testing protocols and tooling
- packaging, releasing, publishing
- unique SDLC elements that are specific to python projects
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 reviewing the suggestion in pull request #24 and the issue's proposed guidelines or docs folder structure. Define the scope and organization for Python guidance across style, tooling, architecture, packages, testing, packaging, releasing, publishing, and SDLC practices. Done means the project has an agreed, usable set of Python development guidelines.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100