@@ -4,22 +4,25 @@ Contributing to fluent-compiler
4
4
Issues
5
5
------
6
6
7
- You can help by filing bugs on GitHub: https://github.com/django-ftl/fluent-compiler/issues
7
+ You can help by filing bugs on GitHub:
8
+ https://github.com/django-ftl/fluent-compiler/issues.
8
9
9
10
Please check existing issues before filing a new one.
10
11
12
+
11
13
Development environment
12
14
-----------------------
13
15
14
- To contribute fixes and features, you'll need to get set up for development:
16
+ To contribute fixes and features, you'll need to get set up for
17
+ development:
15
18
16
- 1. For ``fluent_compiler `` on github
17
- 2. Checkout a copy of the project using
18
- 3. Create a virtualenv for development (or your preferred mechanism
19
- for isolated Python environments)
19
+ 1. Fork ``fluent_compiler `` on GitHub.
20
+ 2. Clone and go to the forked repository.
21
+ 3. Create and activate a virtual environment for development (or your
22
+ preferred mechanism for isolated Python environments).
20
23
4. Install the package in development mode::
21
24
22
- ./setup.py develop
25
+ pip install -e .
23
26
24
27
5. Install test requirements::
25
28
@@ -34,27 +37,28 @@ If all that is successful, you are in good shape to start developing!
34
37
We also have several linters and code formatters that we require use of,
35
38
including `flake8 <http://flake8.pycqa.org/en/latest/ >`_, `isort
36
39
<https://github.com/timothycrosley/isort#readme> `_ and `black
37
- <https://github.com/psf/black> `_. These are most easily add by using ` pre-commit
38
- <https://pre-commit.com/> `_:
40
+ <https://github.com/psf/black> `_. These are most easily add by using
41
+ ` pre-commit <https://pre-commit.com/ >`_:
39
42
40
- * Install pre-commit globally e.g. ``pipx install pre-commit `` if you already
41
- have `pipx <https://github.com/pypa/pipx >`_.
43
+ * Install pre-commit globally e.g. ``pipx install pre-commit `` if you
44
+ already have `pipx <https://github.com/pypa/pipx >`_.
42
45
43
46
* Do ``pre-commit install `` in the repo.
44
47
45
48
Now all the linters will run when you commit changes.
46
49
47
- To run tests on multiple Python versions locally you can also install and use
48
- ``tox ``.
50
+ To run tests on multiple Python versions locally you can also install
51
+ and use ``tox ``.
49
52
50
53
51
54
Fixes and features
52
55
------------------
53
56
54
57
Please submit fixes and features by:
55
58
56
- 1. First creating a branch for your changes
57
- 2. Sending us a PR on GitHub
59
+ 1. First creating a branch for your changes.
60
+ 2. Sending us a PR on GitHub.
58
61
59
- For new features it is often better to open an issue first to see if we agree
60
- that the feature is a good idea, before spending a lot of time implementing it.
62
+ For new features it is often better to open an issue first to see if we
63
+ agree that the feature is a good idea, before spending a lot of time
64
+ implementing it.
0 commit comments