Skip to content

Commit 009f1a8

Browse files
committed
docs: fix and improve CONTRIBUTING.rst
1 parent d8f19b4 commit 009f1a8

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

CONTRIBUTING.rst

+21-17
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,25 @@ Contributing to fluent-compiler
44
Issues
55
------
66

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.
89

910
Please check existing issues before filing a new one.
1011

12+
1113
Development environment
1214
-----------------------
1315

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:
1518

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).
2023
4. Install the package in development mode::
2124

22-
./setup.py develop
25+
pip install -e .
2326

2427
5. Install test requirements::
2528

@@ -34,27 +37,28 @@ If all that is successful, you are in good shape to start developing!
3437
We also have several linters and code formatters that we require use of,
3538
including `flake8 <http://flake8.pycqa.org/en/latest/>`_, `isort
3639
<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/>`_:
3942

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>`_.
4245

4346
* Do ``pre-commit install`` in the repo.
4447

4548
Now all the linters will run when you commit changes.
4649

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``.
4952

5053

5154
Fixes and features
5255
------------------
5356

5457
Please submit fixes and features by:
5558

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.
5861

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

Comments
 (0)