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-review process #1

Open
ross-spencer opened this issue May 2, 2023 · 0 comments
Open

Add code-review process #1

ross-spencer opened this issue May 2, 2023 · 0 comments

Comments

@ross-spencer
Copy link
Member

  • A conversation.
  • Trying to capture slightly different happy-paths and exception-paths.
  • Find a common understanding.
  • About progress, not perfection.
  • A way to share experiences that are embedded in code to improvie it.
  • Ultimately, should be safe, and rewarding.

  • Rely as much on tooling as possible:
    • black - code formatting.
    • pylint - improving style and adherence to standards.
    • flake - identify code errors and adherence to PEP guidelines and principles.
    • isort - organize imports automatically for us (and helps to ensure they function correctly).
  • Future tooling to keep an eye on:
    • mypy - incoming.
    • markdwn linting - still to find.
    • docstring linting - not as important with mypy.
  • Tests
    • Unit tests,
    • Behavioral driven,
    • Type-testing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant