keptn / community

Keptn community content: governance, community management, project infrastructure etc.
https://keptn.sh/community
Apache License 2.0
52 stars 46 forks source link

Create a common file about working with git #217

Closed StackScribe closed 1 year ago

StackScribe commented 1 year ago

Proposal

We need a single document that summarizes how to work with git and DCO for all Keptn projects. For new users, figuring out the right thing from all the git documentation can be overwhelming so we need a simple "cheatsheat" that discusses the basic steps people need to take to create a PR. We currently have information for this in the CONTRIBUTING.md files for individual repos but this should be consolidated into a single file that is appropriate for all projects and repositories.

This is not big enough to be a full GSoC project but it might be combined with other work or might be a good-first-issue for people preparing to be mentees.

References

CONTRIBUTING.md files in keptin.github.io, keptn/keptn, lifecycle-toolkit, and lifecycle-toolkit/docs

Sponsors

Checklist

rakshitgondwal commented 1 year ago

I would like to take this up! @StackScribe

rakshitgondwal commented 1 year ago

I have made a list of things that should be mentioned in this document-

@StackScribe Are there any other things that need to be mentioned in this document?

DavidPHirsch commented 1 year ago

connected PR is closed