Commit af56f87c authored by Marco Govoni's avatar Marco Govoni
Browse files

Update CONTRIBUTING.md

parent 5189de32
# Contributing to the source
Contributions are welcomed via merge requests. Contact the **WEST** developers before starting work to ensure it meshes well with the planned development direction and
standards set for the project.
# Features
## Version control
All changes in a pull request should be closely related. Multiple change sets that are loosely coupled should be proposed in separate pull requests. Use a consistent style for writing code.
## Features
New features should be applicable to a variety of use-cases. The **WEST** developers can assist you in designing flexible interfaces.
# Version control
## Testing
All changes in a pull request should be closely related. Multiple change sets that are loosely coupled should be proposed in separate pull requests. Use a consistent style for writing code.
Add tests for all new functionality.
# Documentation
## Release
We use [semantic versioning](https://semver.org/), i.e. version labels have the form v<major>.<minor>.<patch>
- Patch release: v0.8.1 to v0.8.2, only bug fixes
- Minor release: v0.8.1 to v0.9.0, bug fixes and new features that maintain backwards compatibility
- Major release: v0.8.1 to v1.0.0, bug fixes and new features that break backwards compatibility
# Contributing to the documentation
Comment complex sections of code so that other developers can understand them.
Add demonstrations of new functionality, e.g. using Jupyter notebooks.
# Testing
Add tests for all new functionality.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment