@@ -7,39 +7,10 @@ Contributor Guide
77 :discussion-type: `discussion board <question> ` and we'll answer them.
88
99This project uses the `GitHub Flow `_ (more detail :ref: `below <Making a Pull Request >`)
10- for collaboration and consists primarily of Python code and Javascript code. A variety
11- of tools are used to aid in its development. Below is a brief list of the most commonly
12- used tools:
13-
14- .. list-table ::
15- :header-rows: 1
16-
17- * - Tool
18- - Used For
19-
20- * - Git _
21- - version control
22-
23- * - Nox _
24- - automating development tasks.
25-
26- * - PyTest _
27- - executing the Python-based test suite
28-
29- * - pre-commit _
30- - helping impose basic style guidelines
31-
32- * - NPM _
33- - managing and installing Javascript packages
34-
35- * - Selenium _ and ChromeDriver _
36- - to control the browser while testing
37-
38- * - `GitHub Actions `_
39- - hosting and running our CI/CD suite
40-
41- * - Docker _ and Heroku _
42- - containerizing and hosting this documentation
10+ for collaboration and consists primarily of Python code and Javascript code. A
11+ :ref: `variety of tools <Development Environment >` are used to aid in its development.
12+ Any code contributed to IDOM is validated by a :ref: ` series of tests <Running The
13+ Tests> ` to ensure its quality and correctness.
4314
4415
4516Making a Pull Request
@@ -193,26 +164,26 @@ fails, the installation of the Python package with ``pip`` will too.
193164Code Quality Checks
194165-------------------
195166
196- Several tools are run on the Python codebase to help validate its quality. For the most
197- part, if you set up your :ref: `Development Environment ` with `` pre-commit `` to check
198- your work before you commit it, then you'll be notified when changes need to be made or,
199- in the best case, changes will be made automatically for you.
167+ Several tools are run on the codebase to help validate its quality. For the most part,
168+ if you set up your :ref: `Development Environment ` with pre-commit _ to check your work
169+ before you commit it, then you'll be notified when changes need to be made or, in the
170+ best case, changes will be made automatically for you.
200171
201172The following are currently being used:
202173
203174- MyPy _ - a static type checker
204175- Black _ - an opinionated code formatter
205176- Flake8 _ - a style guide enforcement tool
206177- ISort _ - a utility for alphabetically sorting imports
178+ - Prettier _ - a tool for autimatically formatting Javascript code
207179
208180The most strict measure of quality enforced on the codebase is 100% coverage. This means
209181that every line of coded added to IDOM requires a test case that exercises it. This
210182doesn't prevent all bugs, but it should ensure that we catch the most common ones.
211183
212184If you need help understanding why code you've submitted does not pass these checks,
213- then be sure to ask, either in the
214- `Community Forum <https://github.com/idom-team/idom/discussions >`__ or in your
215- :ref: `Pull Request <Making a Pull Request >`.
185+ then be sure to ask, either in the :discussion-type: `Community Forum <question> ` or in
186+ your :ref: `Pull Request <Making a Pull Request >`.
216187
217188.. note ::
218189
0 commit comments