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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
So you've started using `autoimport` and want to show your gratitude to the project,
depending on your programming skills there are different ways to do so.
# I don't know how to program
There are several ways you can contribute:
* [Open an issue](https://github.com/lyz-code/autoimport/issues/new) if you encounter
any bug or to let us know if you want a new feature to be implemented.
* Spread the word about the program.
* Review the [documentation](https://lyz-code.github.io/autoimport) and try to improve
it.
# I know how to program in Python
If you have some python knowledge there are some additional ways to contribute.
We've ordered the [issues](https://github.com/lyz-code/autoimport/issues) in
[milestones](https://github.com/lyz-code/autoimport/milestones), check the issues in
the smaller one, as it's where we'll be spending most of our efforts. Try the
[good first
issues](https://github.com/lyz-code/autoimport/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22),
as they are expected to be easier to get into the project.
We develop the program with
[TDD](https://en.wikipedia.org/wiki/Test-driven_development), so we expect any
contribution to have it's associated tests. We also try to maintain an updated
[documentation](https://lyz-code.github.io/autoimport) of the project, so think if
your contribution needs to update it.
We know that the expected code quality is above average. Therefore it might
be challenging to get the initial grasp of the project structure, know how to make the
tests, update the documentation or use all the project technology stack. but please
don't let this fact discourage you from contributing:
* If you want to develop a new feature, explain how you'd like to do it in the related issue.
* If you don't know how to test your code, do the pull request without the tests
and we'll try to do them for you.
# Issues
Questions, feature requests and bug reports are all welcome as issues.
**To report a security vulnerability, please see our [security
policy](https://github.com/lyz-code/autoimport/security/policy) instead.**
To make it as simple as possible for us to help you, please include the output
of the following call in your issue:
```bash
python -c "import autoimport.version; print(autoimport.version.version_info())"
```
or if you have `make` installed, you can use `make version`.
Please try to always include the above unless you're unable to install `autoimport` or know it's not relevant to your question or
feature request.
# Pull Requests
*autoimport* is released regularly so you should see your
improvements release in a matter of days or weeks.
!!! note
Unless your change is trivial (typo, docs tweak etc.), please create an
issue to discuss the change before creating a pull request.
If you're looking for something to get your teeth into, check out the ["help
wanted"](https://github.com/lyz-code/autoimport/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
label on github.
# Development facilities
To make contributing as easy and fast as possible, you'll want to run tests and
linting locally.
!!! note ""
**tl;dr**: use `make format` to fix formatting, `make` to run tests and linting & `make docs`
to build the docs.
You'll need to have python 3.6, 3.7, or 3.8, virtualenv, git, and make installed.
* Clone your fork and go into the repository directory:
```bash
git clone git@github.com:<your username>/autoimport.git
cd autoimport
```
* Set up the virtualenv for running tests:
```bash
virtualenv -p `which python3.7` env
source env/bin/activate
```
* Install autoimport, dependencies and configure the
pre-commits:
```bash
make install
```
* Checkout a new branch and make your changes:
```bash
git checkout -b my-new-feature-branch
```
* Fix formatting and imports: autoimport uses
[black](https://github.com/ambv/black) to enforce formatting and
[isort](https://github.com/timothycrosley/isort) to fix imports.
```bash
make format
```
* Run tests and linting:
```bash
make
```
There are more sub-commands in Makefile like `test-code`, `test-examples`,
`mypy` or `security` which you might want to use, but generally `make`
should be all you need.
If you need to pass specific arguments to pytest use the `ARGS` variable,
for example `make test ARGS='-k test_markdownlint_passes'`.
* Build documentation: If you have changed the documentation, make sure it
builds the static site. Once built it will serve the documentation at
`localhost:8000`:
```bash
make docs
```
* Commit, push, and create your pull request.
We'd love you to contribute to *autoimport*!
|
