Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1.19 KB
Raw

Contributing to Loculus

Contributions are very welcome! Just fork the repository, develop in a branch and submit a pull request.

Commit Messages

We follow conventional commits when writing commit messages. The messages themselves should help future developers understand why changes were made.

Code Style

We value clean code, here are some guidelines on what we consider clean code:

  • Use expressive names (variables, classes, function), avoid abbreviations unless they are really common sense
  • Small functions and classes
  • Reasonable test coverage: We don't require 100% test coverage, but we do require tests for all non-trivial code. End-to-end tests should be expressive and cover the most important use cases. Every piece of the code should at least be tested in the happy path.
  • Develop code with testability in mind.

Keep in mind that Loculus is designed to be run and maintained by anyone. This means that the code that we develop needs to be suitably general and configurable.

OpenAPI docs

The backend offers a Swagger UI and an OpenAPI specification. Try to keep the OpenAPI specification as correct and as useful as possible.