Skip to content

Latest commit

 

History

History
77 lines (62 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

77 lines (62 loc) · 2.86 KB
Raw

Contributing to MultiCounter

Thank you for your interest in contributing to MultiCounter! This document will guide you through setting up your development environment so you can bring your ideas for MultiCounter to life.

Development Setup

This project ships with a VS Code "devcontainer" to provide you with the easiest possible environment setup.

  1. Make sure you have both Docker and VS Code (including the Remote Containers Extension) installed on your machine.

  2. Make your own fork of MultiCounter

  3. Clone the source code of MultiCounter onto your machine and open it in VS Code

    • Make sure to replace YOUR_GITHUB_USERNAME in the command below with your actual GitHub username!
git clone https://github.com/YOUR_GITHUB_USERNAME/multicounter.git
cd multicounter
code .

  1. Accept the prompt from VS Code to Reopen in Container.

    • If you don't see this pop-up, go to View -> Command Palette -> Remote-Containers: Open Folder in Container
    • Note that the devcontainer may take several minutes to load for the first time. Successive launches will be much faster.

  2. Run the unit tests to make sure everything is working.

poetry run pytest

Submitting Contributions

After completing the installation steps above, make whatever bug fixes or improvements you want in the codebase.

When you are done, simply commit your code with a brief message explaining what was changed, and why. A series of automated checks will run to make sure everything looks good before the commit gets saved:

  • The unit test suite will automatically run and inform you of any failing tests that need fixing.
  • Linters will automatically run and correct any code formatting problems. Make sure to git add . after these run to capture their changes.

Finally push up your changes to your fork and open a Pull Request (PR) back into jhale1805/multicounter.

  • A bot will post a link on your PR asking you to sign a standard Contributor License Agreement (CLA) giving me permission to integrate your contribution into the project.
  • Any questions about your contribution will be discussed within the PR's comment section.
  • After everything looks great, your PR will be merged into the main branch of MultiCounter!

Other Useful Information

You can easily update the project dependencies using Poetry.

poetry update