Welcome to Tkinter-Designer contributing guide

October 23, 2022 ยท View on GitHub

Thank you for investing your time in contributing to our project!

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

If you find something that can be improved, solved or changed you are welcome to do so.

Create a new issue

If you spot a problem with the Tkinter-Designer, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters.

Make Changes

Once you find the thing you want to work on.

  1. Fork the repository.
  2. Create a branch for your changes.
  3. Clone and checkout that branch locally.
  4. Install dependencies by pip install -r requirements.txt
  5. Make sure it works as expected.
  6. Make the changes.
  7. Test the changes.
  8. Commit and Push the changes.
  9. Create a Pull Request.

Pull Request

The created Pull request should have a brief description on why and how you made the changes.

Your PR is merged

Congratulations :tada::tada: Thank you :sparkles:.

Once your PR is merged, your contributions will be publicly visible on the Tkinter-Designer.