Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 1.98 KB
Raw

Contributing to Peak Platform Global Images

Despite being primarily maintained by Peak, we welcome pull requests to this repo! We thank you for your time and efforts in making these images better 🙌🏻

Please read our code of conduct before getting started.

Contribution Guide

Making the changes

  • Fork this repository.
  • Create a new branch, remember to give this branch a good name - something that explains its purpose.
  • Make changes to your branch. Depending upon the nature of your change, please make sure to either create a new directory/version or change the existing files. If your change is a breaking change, make sure to create a new version directory incremental to the highest version available for that image. For example if there is a directory/version named v1 for an image, a breaking change would mean creating a new version/directory namely v2 within that image and a non-breaking change would just mean editing/updating some existing files for that image.
  • Once you are happy with the changes, you are ready to create a PR. Remember to test your changes first.
  • Please remember to update the required READMEs when you make any changes.

Raising a PR

  • We have a template for PR description that will be prepopulated when you create a PR. Please go through it once and fill in all the required details before you make a PR. A PR that doesn't use the proper template or doesn't have all the details filled in will be rejected.
  • After review and testing the PR will be merged.

What Next?

  • Once merged, the newer versions of the images will be published.
  • These newer versions will then be available on the Peak platform and can be used 🎉

Issues

  • Please feel free to create an issue if you see any of the images.
  • We have a few issue templates already added that you need to use.
  • If you are planning on making big or breaking changes, please consider creating an issue first.