1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
# 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](https://github.com/gnikit/tkinter-tooltip/blob/master/CODE_OF_CONDUCT.md) and adhere to it in all your interactions with this project.
## 📚 Getting Started
A good place to start is the [Issues tab](https://github.com/gnikit/tkinter-tooltip/issues) 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.
```sh
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](https://www.python.org/) `>= 3.7` and [pip](https://www.python.org/) `>= 21.0`.
To install all Python dependencies open a terminal go into the `tkinter-tooltip` cloned folder and run:
```sh
pip install -e .[dev,docs,examples]
```
<!-- ### Testing 🧪
To verify that your cloning of the GitHub repository worked as expected open a terminal and run:
```sh
pytest -v
```
This will run the entire unit test suite. You can also run this to verify that you haven't broken anything in the code.
👉 **Tip!** You can run individual tests by selecting the path to the Python file and the method
```sh
pytest test/test_interface.py::test_version_update_pypi -->
```
### 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.
<!-- It is however considerably easier to create compact unittests to check if your changes have worked.
👉 **Tip!** You can attach a debugger to the main `tkinter-tooltip` source code during unittesting which should allow you to pause, break, step into, etc. while testing, thus making it easier to find mistakes. -->
### Merging
To merge your changes to the main `tkinter-tooltip` repository push your branch on GitHub and open a [Pull Request](https://github.com/gnikit/tkinter-tooltip/pulls). Ping `@gnikit` to review your PR.
|
