Skip to content

[Improvement] Create a contribution guide. #148

Description

@kalharko

Write a contribution guide at doc/contribution_guide.md.
It should include:

  • The steps to clone, build, enter the project container with vscode (devcontainer).
  • How to run linting, type checking and unit tests localy.
  • A description of the project's file hierarchy.
  • A class diagram for a model, showing relationships with classes ModelABC, BaseModel, nn.Module, ModelSettings.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions