ghaction-upx/.github/CONTRIBUTING.md

Contributing

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.

Submitting a pull request

1. Fork and clone the repository
2. Configure and install the dependencies: npm install
3. Make sure the tests pass on your machine: npm run test
4. Create a new branch: git checkout -b my-branch-name
5. Make your change, add tests, and make sure the tests still pass
6. Compile your Typescript code: npm run build
7. Format your code: npm run format
8. Prune dependencies: npm prune --production
9. Push to your fork and submit a pull request
10. Pat your self 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.
• Make sure the README.md and any other relevant documentation are kept up-to-date.
• We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
• 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.
• Write a good commit message.

Resources

• How to Contribute to Open Source
• Using Pull Requests
• GitHub Help