Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Contributions to this project are released to the public under the project's open source license.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
- Fork and clone the repository
- Add your workflows to the
workflowsdirectory. Each action should be in its own subdirectory, and the name of the subdirectory should match the name of the action. - Make sure your workflow file has setup instruction at the top of it in comments.
- Make sure to add a
README.mdfile in the action's subdirectory. This file should describe what the action does, how to use it, and any inputs or outputs it has. - Make sure to add your action to the
README.mdfile in the root of the repository. This file should list all the actions in the repository and provide a brief description of each one. - Push to your fork and submit a pull request
- Pat yourself on the back and wait for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Show what the output of the workflow looks like. If you can, include a screenshot or a link to a run of the workflow in your pull request description.
- Only submit one workflow per pull request. This makes it easier for us to review and merge your changes.
- Write a good commit message.