Skip to content

Commit

Permalink
update readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
sheppard committed Jun 22, 2023
1 parent 1098479 commit 59c7aa6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
22 changes: 12 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,18 @@ Thanks for contributing to the wq framework! Here are some guidelines to help y

## Questions

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.
Questions and ideas can be submitted to the main [wq discussion board](https://github.com/wq/wq/discussions).

## Bug Reports

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.

* [wq](https://github.com/wq/wq/issues): General API design & documentation
* [wq.app](https://github.com/wq/wq.app/issues): JavaScript client & build tool
* [wq.build](https://github.com/wq/wq.build/issues): CLI & Project build tools
* [wq.create](https://github.com/wq/wq.create/issues): `wq create` command & project templates
* [wq.db](https://github.com/wq/wq.db/issues): Web server & REST API (Django REST Framework)
* [wq.create](https://github.com/wq/wq.create/issues): `wq create` command & questions about getting started
* [xlsconv](https://github.com/wq/xlsform-converter/issues): XLSForm converter and default HTML templates
* [xlsconv](https://github.com/wq/xlsform-converter/issues): XLSForm converter

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.

Expand All @@ -23,12 +24,12 @@ Don't worry about getting the repository exactly right - many issues span multip
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:
* 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).
* Failing test case fixed by the PR
* If the PR provides new functionality to wq, a separate PR updating the [wq documentation](https://github.com/wq/wq/tree/master/docs).
* If the PR provides new functionality, a separate PR updating the [wq documentation](https://github.com/wq/wq/tree/main/docs).
* Ensure the PR passes lint and unit tests. This happens automatically, but you can also run these locally with the following commands:

```bash
./runtests.sh # run the test suite
LINT=1 ./runtests.sh # run code style checking
python -m unittest discover -s tests -t . # run the test suite
flake8 # run code style checking
```

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.
Expand All @@ -37,7 +38,7 @@ If you would like help implementing any part of your PR, feel free to enable wri

Small changes and documentation fixes can usually be done using Github's online file editors. For larger changes, we recommend the following workflow.

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:
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.db](https://github.com/wq/wq.db), clone it to your account and then do something like this:

### Initial Setup
```bash
Expand All @@ -55,12 +56,13 @@ git clone git@github.com:[my-username]/wq.db.git
cd wq.db
git checkout -b my-wqdb-branch
```

### Ongoing Development
```bash
cd $WORKSPACE/wq.db
vim rest/some_file.py # (make changes to wq.db)
./runtests.sh # run the test suite
LINT=1 ./runtests.sh # run code style checking
vim wq/db/rest/some_file.py # (make changes to wq.db)
python -m unittest discover -s tests -t . # run the test suite
flake8 # run code style checking

pip install --upgrade . # overwrites PyPI wq.db with local version
cd $WORKSPACE/
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ wq can be installed via PyPI, NPM, or plain `<script>` tag via CDN. See [the do
```bash
python3 -m venv venv
. venv/bin/activate
python3 -m pip install wq==2.0.0a0
python3 -m pip install wq==2.0.0a1
wq create -d myproject.example.com myproject
```

Expand Down

0 comments on commit 59c7aa6

Please sign in to comment.