Skip to content

Establish Python development guidelines #47

@mbarlow12

Description

@mbarlow12

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 -> psycopg3 or asyncpg, etc...)
  • testing protocols and tooling
  • packaging, releasing, publishing
  • unique SDLC elements that are specific to python projects

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions