mirror of
https://github.com/actions/checkout.git
synced 2024-11-25 02:16:53 +01:00
28 lines
1.3 KiB
Markdown
28 lines
1.3 KiB
Markdown
# Contributing
|
|
|
|
## Submitting a pull request
|
|
|
|
1. Fork and clone the repository
|
|
1. Configure and install the dependencies: `npm install`
|
|
1. Create a new branch: `git checkout -b my-branch-name`
|
|
1. Make your change, add tests, and make sure the tests still pass: `npm run test`
|
|
1. Make sure your code is correctly formatted: `npm run format`
|
|
1. Update `dist/index.js` using `npm run build`. This creates a single javascript file that is used as an entrypoint for the action
|
|
1. Push to your fork and submit a pull request
|
|
1. 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:
|
|
|
|
- Write tests.
|
|
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
|
|
|
|
## Resources
|
|
|
|
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
|
|
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
|
|
- [GitHub Help](https://help.github.com)
|
|
- [Writing good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
|
|
|
|
Thanks! :heart: :heart: :heart:
|
|
|
|
GitHub Actions Team :octocat:
|