Contributing (WIP)

This section contains information on how to contribute to this project.

Code style and standards

When developing on this project, please configure your IDE to adhere to the following guidelines.

The code in this repository should be PEP8 coding style guide compliant, with one exception: maximum line length. PEP8 specifies a maximum line length of 79 characters, a relic of a time where widescreen monitors didn’t exist. In this project, we extend the maximum line length to 120 characters.

Furthermore, code documentation in this project should follow the Numpy docstring format as detailed here.

Finally, every Python module in this project should include an Apache License v2.0 statement at the top:

#  Copyright (c) 2020 KTH Royal Institute of Technology
#
#  Licensed under the Apache License, Version 2.0 (the 'License');
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an 'AS IS' BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#   limitations under the License.