Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (32 loc) · 926 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 926 Bytes

🚀 Contributing

Getting started

  1. Ensure you have the Hatch installed (with pipx for example):
  1. Clone the repo
git clone
cd wordcab-transcribe
  1. Install dependencies and start coding
hatch env create
  1. Run tests
# Quality checks without modifying the code
hatch run quality:check

# Quality checks and auto-formatting
hatch run quality:format

# Run tests with coverage
hatch run tests:run

Working workflow

  1. Create an issue for the feature or bug you want to work on.
  2. Create a branch using the left panel on GitHub.
  3. git fetchand git checkout the branch.
  4. Make changes and commit.
  5. Push the branch to GitHub.
  6. Create a pull request and ask for review.
  7. Merge the pull request when it's approved and CI passes.
  8. Delete the branch.
  9. Update your local repo with git fetch and git pull.