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
|
# Contributing
Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.
## Get Started!
Ready to contribute? Here's how to set up `aioemonitor` for local development.
1. Fork the `aioemonitor` repo on GitHub.
2. Clone your fork locally:
```bash
git clone git@github.com:{your_name_here}/aioemonitor.git
```
3. Install the project in editable mode. (It is also recommended to work in a virtualenv or anaconda environment):
```bash
cd aioemonitor/
pip install -e .[dev]
```
4. Create a branch for local development:
```bash
git checkout -b {your_development_type}/short-description
```
Ex: feature/read-tiff-files or bugfix/handle-file-not-found<br>
Now you can make your changes locally.
5. When you're done making changes, check that your changes pass linting and
tests, including testing other Python versions with make:
```bash
make build
```
6. Commit your changes and push your branch to GitHub:
```bash
git add .
git commit -m "Resolves gh-###. Your detailed description of your changes."
git push origin {your_development_type}/short-description
```
7. Submit a pull request through the GitHub website.
## Deploying
A reminder for the maintainers on how to deploy.
Make sure all your changes are committed.
Then run:
```bash
bump2version patch # possible: major / minor / patch
git push
git push --tags
```
This will release a new package version on Git + GitHub and publish to PyPI.
|
