Contributing
Last updated
Was this helpful?
Last updated
Was this helpful?
Quilt is an open source project, and we welcome contributions from the community.
Contributors must adhere to the .
Unsure about something? To get support, check out our .
Found a bug? File it in our .
To work on quilt
you will first need to clone the repository.
You can then set up your own branch version of the code, and work on your changes for a pull request from there.
Use pip
to install quilt
locally (including development dependencies):
All new code contributions are expected to have complete unit test coverage, and to pass all preexisting tests.
Use pytest
to test your changes during normal development. To run pytest
on the entire codebase:
Note that, at the current time, it is only possible to run a local catalog if you already have a catalog deployed to AWS, because the catalog relies on certain services (namely, AWS Lambda and the AWS Elasticsearch Service) which cannot be run locally.
Use npm
to install the catalog (quilt-navigator
) dependencies locally:
There is one known issue with installation. At time of writing, the quilt-navigator
package depends on iltorb@1.3.10
, which may lack prebuilt binaries for your platform and may fall back on building from source using node-gyp
. node-gyp
depends on Python 2; if you only have Python 3 in your install environment it will fail.
To fix this, point npm
to a Python 2 path on your machine. For example on macOS:
Next, you need to create a config.json
and federation.json
file in the catalog/static
subdirectory. For federation.json
use the following template:
For config.json
use the following template:
To build a static code bundle, as would be necessary in order to serve the catalog:
To run the catalog in developer mode:
This uses webpack
under the hood to compile code changes on the fly and provide live reloading, useful when developing.
To run the catalog unit tests:
Create PR with these changes.
Once PR is merged, create a tag from commit with merge: git tag $VERSION $COMMIT_HASH
.
Once you push the tag to GitHub with git push origin $VERSION
a new CI build that makes PyPI release is triggered.
Documentation is served via GitBook, and is based on the docs/
folder in the master
branch of the quilt
repository.
Documentation changes go live at pull request merge time. There is currently no way to preview documentation updates except locally.
To modify the API Reference, modify the docstring associated with a method of interest.
Then, run the following to install the latest version of our docstring parser:
Then navigate to the gendocs
directory and execute python build.py
.
The resulting files will land in docs/
and will be ready to be checked in.
All other pages in the documentation are served from corresponding Markdown pages in the docs
directory. To edit the page, edit the Markdown file. Then check that file in.
This will create an of quilt
, allowing you to modify the code and test your changes right away.
Make sure that any images you check into the repository are at check-in time.
Once you are ready to cut a new release, you update the version in file and in .
The API Reference section of the documentation is served by processing the docstrings in the codebase using a script. We use of the pydoc-markdown
package to do the necessary work.
Quilt is open source under the .