Skip to content

Latest commit

 

History

History
26 lines (20 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

26 lines (20 loc) · 1.29 KB

Contributing to Project CLAI

Adding new features, improving documentation, fixing bugs, or writing tutorials are all examples of helpful contributions. Furthermore, if you are building a new skill, we strongly encourage you to add it to the CLAI skill catalog so that others may also benefit from it as well as contribute to it and improve it.

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

This project uses DCO. Be sure to sign off your commits using the -s flag or adding Signed-off-By: Name<Email> in the commit message.

Example commit message

git commit -s -m 'Informative commit message'

Unit tests

Once you are happy with the implementation of your skill, you can check in sample inputs and outputs in here to make sure your skill runs as intended. See here for an example test with the nlc2cmd skill. Once all the tests have passed, and you are satisfied with the skill, open a PR into the develop branch to add your skill to the CLAI catalog.