This repository is a little different than most you'll find on Github. It consists of primarily submodule links to Skills which actually live in other Github repositories. Due to the complication of submodules, most will never use git commands directly against this repository.
Instead, the Mycroft Skill Kit is the preferred mechanism for submitting and updating Skills to this repository. Submitted skills are reviewed by a team of Mycroft community members to ensure quality and that community standards are followed. You can read more here about our Skills Acceptance Process.
Once a Skill is approved and merged, it will become a submodule here and will appear in the Mycroft Marketplace.
The Mycroft Skill Kit, is a Python utility we created that hides the complications of creating and updating submodules in this repo. It is possible to submit Skills manually, but it is tricky and error-prone so not recommended.
MSK is installed automatically with any Mycroft installation. You generally can access it using the mycroft-msk alias. You can also examine the code directly from the MSK repo.
Skills in this repo should be ready for others to use, not just experiments.
This means you should have done all of these things:
- Created a README.md that conforms to the standard format. Use the Skill Meta Editor to easily create it.
- Added whatever license you want to release your Skill under
- Implemented basic Skill autotests.
- Committed all your code to Github.
Once your Skill is ready for the Marketplace, submitting it for review is as easy as:
cd <local-path-to-your-skill>
mycroft-msk submit .
or:
mycroft-msk submit <local-path-to-your-skill>
That's it! The currently active branch of your repo will be submitted. If a PR is already pending approval, that PR will be updated in place.
By policy, changes to a README.md or translations will automatically be approved and merged. New skills or new functionality will be re-reviewed before approval and merging.
Note: If you have two-factor authentication enabled for github, you will need to generate a personal access token and use the -t flag. E.g.
mycroft-msk -t submit <local-path-to-your-skill>