From 5c3ccc22eb2c950a0fa5bc7c47190d8e3f7e681a Mon Sep 17 00:00:00 2001 From: Cory Miller <13227161+cory-miller@users.noreply.github.com> Date: Thu, 10 Nov 2022 15:54:12 -0500 Subject: [PATCH] Replace datadog/squid with ubuntu/squid Docker image (#1002) * test with ubuntu/squid * Start a contributing guide * remove link --- .github/workflows/test.yml | 2 +- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 0e77c57..c28e771 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -142,7 +142,7 @@ jobs: options: --dns 127.0.0.1 services: squid-proxy: - image: datadog/squid:latest + image: ubuntu/squid:latest ports: - 3128:3128 env: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5c76465 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# 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: