CONTRIBUTING.md 1.18 KB
Newer Older
Marco Govoni's avatar
Marco Govoni committed
1
2
# Contributing to the source

Marco Govoni's avatar
Marco Govoni committed
3
Contributions are welcomed via merge requests. Contact the **WEST** developers before starting work to ensure it meshes well with the planned development direction and
Marco Govoni's avatar
Marco Govoni committed
4
standards set for the project.
Marco Govoni's avatar
Marco Govoni committed
5

Marco Govoni's avatar
Marco Govoni committed
6
7
## Version control

Marco Govoni's avatar
Marco Govoni committed
8
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.
Marco Govoni's avatar
Marco Govoni committed
9
10

## Features
Marco Govoni's avatar
Marco Govoni committed
11

Marco Govoni's avatar
Marco Govoni committed
12
New features should be applicable to a variety of use-cases. The **WEST** developers can assist you in designing flexible interfaces.
Marco Govoni's avatar
Marco Govoni committed
13

Marco Govoni's avatar
Marco Govoni committed
14
## Testing
Marco Govoni's avatar
Marco Govoni committed
15

Marco Govoni's avatar
Marco Govoni committed
16
Add tests for all new functionality.
Marco Govoni's avatar
Marco Govoni committed
17

Marco Govoni's avatar
Marco Govoni committed
18
19
## Release

Marco Govoni's avatar
Marco Govoni committed
20
We use [semantic versioning](https://semver.org/), i.e. version labels have the form v`<major>`.`<minor>`.`<patch>`
Marco Govoni's avatar
Marco Govoni committed
21

Marco Govoni's avatar
Marco Govoni committed
22
23
24
 - Patch release: v0.0.0 to v0.0.1, only bug fixes
 - Minor release: v0.0.0 to v0.1.0, bug fixes and new features that maintain backwards compatibility
 - Major release: v0.0.0 to v1.0.0, bug fixes and new features that break backwards compatibility
Marco Govoni's avatar
Marco Govoni committed
25
26

# Contributing to the documentation
Marco Govoni's avatar
Marco Govoni committed
27

Marco Govoni's avatar
Marco Govoni committed
28
29
Comment complex sections of code so that other developers can understand them.
Add demonstrations of new functionality, e.g. using Jupyter notebooks.
Marco Govoni's avatar
Marco Govoni committed
30