-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
48 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!--- Thank you for your contribution to miniwdl! Please see the CONTRIBUTING.md guidelines and observe the PR checklist below. ---> | ||
|
||
### Motivation | ||
... | ||
<!--- and/or link to related GitHub issue ---> | ||
|
||
### Approach | ||
... | ||
|
||
### Checklist | ||
|
||
<!--- You're welcome to open a draft PR to request guidance on testing or Pyre/Pylint problems. ---> | ||
- [ ] Add appropriate test(s) to the automatic suite | ||
- [ ] Use `make check` to run static checks on the code using [Pyre](https://pyre-check.org/) and [Pylint](https://www.pylint.org/) | ||
- [ ] Use `make pretty` to reformat the code with [black](https://github.com/python/black) | ||
- [ ] Send PR from a dedicated branch without unrelated edits | ||
- [ ] Ensure compatibility with this project's MIT license |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Contributing to miniwdl | ||
|
||
Feedback and contributions to miniwdl are welcome, via issues and pull requests on this repository. | ||
|
||
* The [Project board](https://github.com/chanzuckerberg/miniwdl/projects/1) shows our current prioritization of [issues](https://github.com/chanzuckerberg/miniwdl/issues) | ||
* [Starter issues](https://github.com/chanzuckerberg/miniwdl/issues?q=is%3Aopen+is%3Aissue+label%3Astarter) are good potential entry points for new contributors | ||
|
||
To set up your local development environment, | ||
|
||
1. `git clone --recursive` this repository or your fork thereof | ||
2. Install dependencies as illustrated in the [Dockerfile](https://github.com/chanzuckerberg/miniwdl/blob/master/Dockerfile) (OS packages + PyPI packages listed in `requirements.txt` and `requirements.dev.txt`) | ||
3. Invoking user must have [permission to control Docker](https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user) | ||
|
||
To invoke the `miniwdl` command-line interface from your working repository, e.g. `python3 -m WDL check ...` or `python3 -m WDL run ...`. | ||
|
||
The Makefile has a few typical flows: | ||
|
||
- `make` or `make test` runs the full test suite with code coverage report (takes several minutes) | ||
- `make qtest` runs most of the tests more quickly (by omitting some slower cases, and not tracking coverage) | ||
- `make pretty` reformats the code with [black](https://github.com/python/black) | ||
- `make check` validates the code with [Pylint](https://www.pylint.org/) and [Pyre](https://pyre-check.org/) | ||
|
||
To quickly run only a relevant subset of the tests, you can e.g. `python3 -m unittest -f tests/test_5stdlib.py` or `python3 -m unittest -f tests.test_5stdlib.TestStdLib.test_glob`. | ||
|
||
The [pull request template](https://github.com/chanzuckerberg/miniwdl/blob/master/.github/pull_request_template.md) includes a checklist for preparing your PR. Thank you! | ||
|
||
## Security | ||
|
||
Please disclose security issues responsibly by contacting [email protected]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters