Contributing Guidelines

[StefanGreve]

Preamble

It's ample time to define a short contributing guideline to streamline the onboarding process. By convention this information is usually put down in a CONTRIBUTING.md file at root level.

Requirements

Some suggestions from me about what the content could encapsulate:

• branching policy
• code style
• documentation
• testing
• feature suggestions
• bug reports

Remarks

• For bug reports specifically, we could start to make use of issue template feature. Ideally, this file would also have a few comments about making feature requests here in the discussions panel rather than opening a new issue in this repository.

• I don't think we need to include an in-depth code style guideline.

• As far as documentation is concerned, it would be great if we could adapt sphinx as a documentation generator in the future. This seems to be a good starter guide to help us get started.

Planning Status

Scheduled for milestone 1.1.0.