CONTRIBUTING.md 774 Bytes
Newer Older
Marco Govoni's avatar
Marco Govoni committed
1
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
2
standards set for the project.
Marco Govoni's avatar
Marco Govoni committed
3

Marco Govoni's avatar
Marco Govoni committed
4
# Features
Marco Govoni's avatar
Marco Govoni committed
5

Marco Govoni's avatar
Marco Govoni committed
6
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
7

Marco Govoni's avatar
Marco Govoni committed
8
# Version control
Marco Govoni's avatar
Marco Govoni committed
9

Marco Govoni's avatar
Marco Govoni committed
10
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
11

Marco Govoni's avatar
Marco Govoni committed
12
# Documentation
Marco Govoni's avatar
Marco Govoni committed
13

Marco Govoni's avatar
Marco Govoni committed
14
15
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
16

Marco Govoni's avatar
Marco Govoni committed
17
18
19
# Testing

Add tests for all new functionality.