Contributing

Contributing to the Project

Setting up the Project

Requirements

• Git
• Python
  • Python 3.11 or higher
  • Python Tkinter must also be installed
• Poetry
• FFTW3
• GCC or Clang

1. Clone the git repository

git clone https://github.com/kharanpv/Cartogram_Maker.git

2. Install cart from the cart directory
3. Add the cart and interp executables to the path
4. Install all dependencies

poetry install

5. Run the application

poetry run main-app

Code Guidelines

All code submitted should be formatted with the Python Black code formatter using default settings and follow the PEP8 Style Guide. All custom customtkinter components should each be their own class and own file. Each file should have the same name as the component class it contains to ensure easy discoverability of components for other developers.

Pull Requests

When creating a pull request, give a descriptive title for the PR and if fixing an issue, mention the issue that the PR fixes. If changes to the UI are made, provide before and after pictures of the UI changes to give reviewers a good understanding of the change in UI/UX.