You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+25-17
Original file line number
Diff line number
Diff line change
@@ -4,17 +4,18 @@ Thanks for contributing to the wq framework! Here are some guidelines to help y
4
4
5
5
## Questions
6
6
7
-
Feel free to use the issue tracker to ask questions! We don't currently have a separate mailing list or active chat tool. However, note that as wq grows we may eventually move questions to a separate tool.
7
+
Questions and ideas can be submitted to the main [wq discussion board](https://github.com/wq/wq/discussions).
8
8
9
9
## Bug Reports
10
10
11
11
wq is a highly modular framework and the code is split across several repositories. If you are unsure where to report an issue, feel free to use the top-level [wq repository](https://github.com/wq/wq/issues). Otherwise, enter your issue on the repository that most closely matches the component you are using.
12
12
13
13
*[wq](https://github.com/wq/wq/issues): General API design & documentation
Don't worry about getting the repository exactly right - many issues span multiple repositories and we can always reference the fix back to the original ticket.
20
21
@@ -23,12 +24,12 @@ Don't worry about getting the repository exactly right - many issues span multip
23
24
Pull requests are very welcome and will be reviewed and merged as time allows. To speed up reviews, try to include the following whenever possible:
24
25
* Reference the issue that the PR fixes (e.g. [#22](https://github.com/wq/wq/issues/22) or [wq/wq#22](https://github.com/wq/wq/issues/22) if in a different repository).
25
26
* Failing test case fixed by the PR
26
-
* If the PR provides new functionality to wq, a separate PR updating the [wq documentation](https://github.com/wq/wq/tree/master/docs).
27
+
* If the PR provides new functionality, a separate PR updating the [wq documentation](https://github.com/wq/wq/tree/main/docs).
27
28
* Ensure the PR passes lint and unit tests. This happens automatically, but you can also run these locally with the following commands:
28
29
29
30
```bash
30
-
./runtests.sh# run the test suite
31
-
LINT=1 ./runtests.sh# run code style checking
31
+
python -m unittest discover -s tests -t .# run the test suite
32
+
flake8# run code style checking
32
33
```
33
34
34
35
If you would like help implementing any part of your PR, feel free to enable write access and we'll take a look as time allows.
@@ -37,7 +38,7 @@ If you would like help implementing any part of your PR, feel free to enable wri
37
38
38
39
Small changes and documentation fixes can usually be done using Github's online file editors. For larger changes, we recommend the following workflow.
39
40
40
-
Because wq is split across several repositories, we recommend installing the entire suite from PyPI, starting a test project, and then cloning the specific module you want to update. For example, to work on [wq.db](https://github.com/wq/wq.db), clone it to your account and then do something like this:
41
+
Because wq is split across several repositories, we recommend installing the `wq` package, starting a test project, and then cloning the specific module you want to update. For example, to work on [wq.app](https://github.com/wq/wq.app), clone it to your account and then do something like this:
While wq.app is distributed as a Python wheel, it consists primarily of JavaScript and CSS files built via npm. Development of wq.app requires npm installation as well.
61
+
58
62
### Ongoing Development
59
63
```bash
60
-
cd$WORKSPACE/wq.db
61
-
vim rest/some_file.py # (make changes to wq.db)
62
-
./runtests.sh # run the test suite
63
-
LINT=1 ./runtests.sh # run code style checking
64
+
cd$WORKSPACE/wq.app
65
+
npm install # install NPM dependencies
66
+
vim packages/app/src/app.js # (make changes a wq.app source file)
67
+
npm run test# run the test suite
68
+
npm run lint # run static error checker
69
+
npm run prettier-all # run code formatter
64
70
65
-
pip install --upgrade .# overwrites PyPI wq.db with local version
71
+
python -m packages.builder # Regenerate SHA hashes (recommended for commit)
72
+
python -m build
73
+
pip install dist/*.whl # overwrites PyPI wq.app with local version
0 commit comments