actions/checkout
1
0
Fork 0
mirror of https://code.forgejo.org/actions/checkout.git synced 2024-12-22 08:41:56 +01:00
Code Issues Projects Releases Packages Wiki Activity
checkout/CONTRIBUTING.md
Cory Miller 5c3ccc22eb
Replace datadog/squid with ubuntu/squid Docker image (#1002) 
* test with ubuntu/squid

* Start a contributing guide

* remove link
2022-11-10 15:54:12 -05:00

1.3 KiB
Raw Permalink Blame History

Contributing

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: npm install
  3. Create a new branch: git checkout -b my-branch-name
  4. Make your change, add tests, and make sure the tests still pass: npm run test
  5. Make sure your code is correctly formatted: npm run format
  6. Update dist/index.js using npm run build. This creates a single javascript file that is used as an entrypoint for the action
  7. Push to your fork and submit a pull request
  8. 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

Thanks! ❤️ ❤️ ❤️

GitHub Actions Team :octocat: