CONTRIBUTING.md

Contributing

👍🎉 Thank you for taking the time to contribute! 🎉👍

In this file you will find all the steps necessary to guide you through your first contribution to the project.

Please note our Code of Conduct and adhere to it in all your interactions with this project.

📚 Getting Started

A good place to start is the Issues tab on GitHub. Look for any issues with the help wanted tag.

Downloading ⬇️

Firstly, fork the repository from https://github.com/gnikit/tkinter-tooltip.

Then clone the forked repository into your local machine.

git@github.com:<YOUR-USERNAME>/tkinter-tooltip.git

Where <YOUR-USERNAME> should be your GitHub username.

Dependencies

To build this project you will need Python >= 3.7 and pip >= 21.0. To install all Python dependencies open a terminal go into the tkinter-tooltip cloned folder and run:

pip install -e .[dev,docs,examples]

### Developing & Debugging 🐞️

❗️ Before you start developing, open a terminal inside `tkinter-tooltip` and run:

```sh
pre-commit install

This will ensure that all you commits meet the formatting standards of the project.

---

You can now start writing code! Your local tkinter-tooltip version will be updated with every code change you make, so you can use your normal code editor to checkout the tkinter-tooltip features that you have implemented.

Merging

To merge your changes to the main tkinter-tooltip repository push your branch on GitHub and open a Pull Request. Ping @gnikit to review your PR.