Style Guide

This document serves as a style guide for all software development on the imap-processing and sds-data-manager repositories. Any potential contribution to the these repositories should be checked against this guide, and any violation of the guide should be fixed before the code is committed to the main or dev branches.

tl;dr

The following is a short version of this style guide to be used as a quick reference. Further details about each of these items are provided below in the guide.

1. Use a forking workflow for git/GitHub contributions.

2. Use PEP8 for python coding conventions (with a few exceptions).

3. Use PEP257 and numpydocs for docstring conventions (with a few exceptions), and update the documentation builds where applicable.

4. Update the poetry environment when dependencies change.

5. Be mindful of committing credentials and other sensitive information.

6. Follow agreed-upon naming conventions where applicable.

7. Use specific tools and libraries where applicable.

8. Use nominal semantic versioning for version numbers.

Contributors can refer to the checklist for contributors and reviewers of pull requests for assistance in making sure pull requests are adhering to these conventions.