Skip to content
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.

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

Add Code quality guidelines to TARDIS docs #1253

Closed
jaladh-singhal opened this issue Jul 28, 2020 · 1 comment · Fixed by #1405
Closed

Add Code quality guidelines to TARDIS docs #1253

jaladh-singhal opened this issue Jul 28, 2020 · 1 comment · Fixed by #1405

Comments

@jaladh-singhal
Copy link
Member

jaladh-singhal commented Jul 28, 2020

The main aim of these guidelines will be to explain what does good quality code in a PR expects (meaning of "maintaining code quality" section in CONTRIBUTING.md):

  • code covers edge cases, exception handling where required
  • easy to maintain and extend - OOP design pattern
  • follows PEP8 style guide (use of black)
  • more pointers can be found in this code quality guide by real-python

Code style guide (#1170) should probably be a section within it and this guide should be placed within "Contributing to TARDIS" section in https://github.com/tardis-sn/tardis/blob/master/docs/index.rst

NEED: This is pointed in CONTRIBUTING.md as a void link (#), so it is necessary to add them soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants