Developer Handbook - swe574-spring23/SWE574 GitHub Wiki

Developer Handbook

Welcome!

Developer handbook is a resource to find detailed information about our development processes.

Contents

Newcomers:

  • Creating a pull request

Github:

  • Commit message
  • Developing a new feature
  • Branches
  • Labels
  • Milestones
  • Project

Front-end:

Back-end:

DevOps:

  • Coding Style Guide
  • Useful resources for newcomers

Project Management:

Linting

Each commit must be linted. Pre-commit is currently configured for flake8, isort and black. So, please install the pre-commit linter hook by running the following command from the terminal you use git:

pip install pre-commit
pre-commit install

To manually run all pre-commit hooks on a repository:

pre-commit run --all-files

To update versions of pre-commit hooks to the latest version automatically:

pre-commit autoupdate