search

layer5io / learn-layer5

A sample application for learning how to service mesh and for validating SMI conformance
https://layer5.io
Apache License 2.0
63 stars 30 forks source link

[Docs] Include instructions on signing commits in the CONTRIBUTING.md #21

Closed leecalcote closed 4 years ago

leecalcote commented 4 years ago

Current Behavior The CONTRIBUTING.md in this repo is missing an explanation and instructions on signing off on commits.

Desired Behavior A copy of the same instructions from the Meshery repo's CONTRIBUTING.md's section on signing commits should be placed in into this repo's contributing instructions.

We will need to copy over the screenshots as well, which can be placed into the readme folder here - https://github.com/layer5io/learn-layer5/tree/master/img/readme

Jashpatel1 commented 4 years ago

This repo dosen't contain CONTRIBUTING.md . So is it to be included in README.md or to create a new CONTRIBUTING.md.

leecalcote commented 4 years ago

@Jashpatel1 thanks for confirming. You're right - let's create a new CONTRIBUTING.md file here.

Jashpatel1 commented 4 years ago

@leecalcote Is it something i can help with?

leecalcote commented 4 years ago

@Jashpatel1 yes, that would be excellent. Thank you.

Jashpatel1 commented 4 years ago

@leecalcote I don't know more of what the file content should be, So do i include the details of signing of commit as of now.

leecalcote commented 4 years ago

@Jashpatel1 good point. Yes, I suppose for now just having the commit signing section will suffice.

Long-term, we'll want to centralize the contributing instructions into one place for all repos to reference.