This repository contains only information about proprietary images. None of the scripts to add a tool, build and test an image or even most of the linked documents exist in this repository. Users can only request a tool, but never add one themselves. There is no need for incomplete documentation on an imposible process.
32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
## Contributing
|
|
|
|
[fork]: https://github.com/actions/partner-runner-images/fork
|
|
[pr]: https://github.com//actions/partner-runner-images/compare
|
|
[code-of-conduct]: CODE_OF_CONDUCT.MD
|
|
|
|
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](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [MIT license](LICENSE.txt).
|
|
|
|
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
|
|
|
|
## Submitting a pull request
|
|
|
|
1. [Fork][fork] and clone the repository
|
|
1. Create a new branch: `git checkout -b my-branch-name`
|
|
1. Make your changes.
|
|
1. Test your changes.
|
|
1. Push to your fork and [submit a pull request][pr]
|
|
|
|
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
|
|
|
|
- Include complete details of why this is needed in the PR description.
|
|
- 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 [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
|
|
|
## 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)
|