New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

2.0 - Coding Guidelines #57

Open

pflarr opened this issue Sep 7, 2018 · 0 comments

Milestone

Collaborator

pflarr commented Sep 7, 2018 •

edited

Loading

The following are the general programming guidelines for working on the Pavilion 2.0 branch.

Follow PEP 8 style guidelines, even the parts you don't like.
Write docstrings using sphinx style for everything. The Yaml_config library is a good example.
Stay as python3 compatible as possible, even though we're in 2.7. Import the following from future in all modules, and use them (where appropriate):

print_statement
division
unicode_literals

Keep modules fairly independent from each other.
Write regression/unit tests (made a lot easier by independent modules...)
Write documentation (in sphinx markup) for both users and contributors.
Push changes to separate branches, and then put in a merge request.

Merge must be approved by a different developer. Unit tests must pass.

Expect and use unicode strings everywhere, for python3 compatibility.

Doc strings

pflarr added this to the 2.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment