asdf-plugins/CONTRIBUTING.md

Contributing

Contributing a new Plugin

1. Clone this repo

   git clone https://github.com/asdf-vm/asdf-plugins
   

2. Install repo dependencies

   asdf install
   

3. Add the plugin to the repository README.md Plugin List table.
4. Create a file with the shortname you wish to be used by asdf in plugins/<name>. The contents should be repository = <your_repo>. Eg:

   printf "repository = https://github.com/asdf-vm/asdf-nodejs.git\n" > plugins/nodejs
   

5. Test your code

   scripts/test_plugin.bash --file plugins/<name>
   

6. Format your code & this README:

   scripts/format.bash
   

7. Create a PR following the instructions in the PR template.
   1. Make sure you use Conventional Commits, both in the commit messages and the pull request title

Fixing an existing plugin

If you see a plugin has an incorrect Build status link, please PR a fix to the correct link.

If you see a plugin which is no longer maintained by the repository owner, please reach out to them on their repo before PRing a removal of the plugin. Sometimes code not actively maintained functions perfectly fine. If you PR a removal, link to the thread showing you attempted to communicate with the owner/author.

---

Thanks for contributing!