Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.68 KB

Contributing to NL2Flow

Adding new features, improving documentation, fixing bugs, or writing tutorials are all examples of helpful contributions. Furthermore, if you are building on the research work, we strongly encourage you to read our paper on workflow construction using natural language here.

Bug fixes can be initiated through GitHub pull requests or PRs. When making code contributions to NL2Flow, we ask that you follow the PEP 8 coding standard and that you provide unit tests for the new features.

This project uses DCO. You must sign off your commits using the -s flag in the commit message.

Example commit message

git commit -s -m 'informative commit message'

Setting up the dev environment

BLACK PYLINT FLAKE8 MYPY

First, follow the general setup instructions here. Then install the dev-specific dependencies and pre-commit hooks.

(nl2flow) user:~$ pip install -e '.[dev]'
(nl2flow) user:~$ pre-commit install

Whether you are contributing a new interaction pattern or addressing an existing issue, you need to ensure that the unit tests pass. The existing tests are housed here.

Once all the tests have passed, and you are satisfied with your contribution, open a pull request into the main branch from your fork of the repository to request adding your contributions to the main code base.