Skip to content

Commit f056b97

Browse files
committed
misc docs improvements
1 parent b185220 commit f056b97

File tree

6 files changed

+19
-45
lines changed

6 files changed

+19
-45
lines changed

.pre-commit-config.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,7 @@ repos:
1212
hooks:
1313
- id: isort
1414
name: isort
15+
- repo: https://github.com/pre-commit/mirrors-prettier
16+
rev: "v2.5.1"
17+
hooks:
18+
- id: prettier

docs/source/_custom_js/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/source/developing-idom/contributor-guide.rst

Lines changed: 11 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,10 @@ Contributor Guide
77
:discussion-type:`discussion board <question>` and we'll answer them.
88

99
This 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

4516
Making a Pull Request
@@ -193,26 +164,26 @@ fails, the installation of the Python package with ``pip`` will too.
193164
Code 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

201172
The 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

208180
The most strict measure of quality enforced on the codebase is 100% coverage. This means
209181
that every line of coded added to IDOM requires a test case that exercises it. This
210182
doesn't prevent all bugs, but it should ensure that we catch the most common ones.
211183

212184
If 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

src/client/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"devDependencies": {
3-
"prettier": "^2.2.1",
43
"snowpack": "^3.5.2"
54
},
65
"license": "MIT",

src/client/packages/idom-app-react/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
},
88
"description": "A client application for IDOM implemented in React",
99
"devDependencies": {
10-
"prettier": "^2.2.1"
10+
"prettier": "^2.5.1"
1111
},
1212
"license": "MIT",
1313
"main": "src/index.js",

src/client/packages/idom-client-react/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"description": "A client for IDOM implemented in React",
88
"devDependencies": {
99
"jsdom": "16.3.0",
10-
"prettier": "^2.2.1",
10+
"prettier": "^2.5.1",
1111
"uvu": "^0.5.1"
1212
},
1313
"files": [

0 commit comments

Comments
 (0)