Developers

• "Alejandro Armas [email protected]",
• "Lia Hepler-Mackey [email protected]",
• "Sachin Loecher [email protected]"
• "Matthew Schulz [email protected]"

Getting Started

We are using poetry as our package manager solution. To get started, run poetry shell, to create a nested shell with a virtual environment. Verify your environment with poetry env info. Then, run poetry install to capture all the dependencies.

To use Comet, make sure to use the environment variable found here

export COMET_API_KEY=<paste_your_key_here>

You should now be able to run a particular script with the following command:

poetry run python -m script.stage_1_script.script_mlp

Testing and Static Analysis

We are using mypy, flake8, isort, pre-commit, and black,

Mypy does Type checking to verify that our code follows its own type annotations. We use annotations to ask for hard guarantees that all of the objects processed by your code — both container and contents — implement the runtime behaviors that your code requires.

To use static type checking on a particular file, use for example:

mypy code/lib/comet_listeners.py

To unit test your code use poetry run python -m unittest. If you are interested in testing a particular file use:

poetry run python -m unittest code.tests.test_example

We are using flake8 as a style linter, to point out issues that don't cause bugs, but make the code less readable or are not in line with style guides such as Python's PEP 8 document. Additionally, it is an error linter, which points out syntax errors or other code that will result in unhandled exceptions and crashes. isort similarly takes care of sorting python import statements.

To use this on a particular file:

poetry run flake8 code/lib/notifier/evaluate_notifier.py

We are using black as a code formatter, to change the style of our code, (mostly revolving around proper whitespace) without affecting the behavior of the program.

poetry run black code/lib/notifier/evaluate_notifier.py

Thankfully this is all automated as a series of pre-commit hooks. If you would like to manually run these, execute with poetry run pre-commit run --all-files. However, expect this to run any time you perform a commit.

Workflow

Before Getting Started

• Discuss what you'll be working on in team meetings / with team leads
• Make sure there is a GitHub issue in the repo that is tracking the item you're working on

Get Started on a Work Item

• On GitHub

  • Assign yourself to the issue you'll work on (if not already)

• In your local Git repo

  • Switch to main branch (unless otherwise specified)
  • Sync latest changes on main branch (IMPORTANT!!!)
  • Create and checkout a new branch from main
    • Branch name may start with the issue ID followed by feature, like 10-code-review-doc
  • Start coding

Work on an Item

• Commit and push changes frequently

  • Please follow Conventional Commits for commit messages
  • Check out the reason behind Adopting Conventional Commits

• Create a pull request on GitHub as early as you make the first commit

  • Title should start with Draft: and followed by the feature, like Draft: Code Review Doc
  • Description should start with a line like Closes #10 to let GitHub link the issue with the pull request automatically

• Write unit tests while developing new features (if applicable)

• Try to resolve merge conflicts (if any) with the target branch as you notice

Finish up

• Clean up code
• Run and pass all related unit tests (if applicable)
• Remove Draft: from title of the pull request
• Request a code review
• Wait for review
• Implement feedbacks (if any) by continue adding commits and request another review
• Wait for approval and merge