documents icon indicating copy to clipboard operation
documents copied to clipboard

Published 20 hours ago • verified publisher icon open-gitops

[WIP] Create CONTRIBUTING.md

Open moshloop opened this issue 3 years ago • 5 comments
trafficstars

This is a very high-level working document designed to solicit comments more than anything else.

moshloop avatar Jan 05 '22 20:01 moshloop

@moshloop Thanks for starting this per the meeting conversation. I think this is a good topic to continue resolving during meetings as well, but good to have a place to discuss async.

scottrigby avatar Jan 17 '22 07:01 scottrigby

I think this is a good start! I wonder if it should be explicitly stated that "All submissions must follow the GitOps Principles" (or something to that effect)?

christianh814 avatar Jan 27 '22 00:01 christianh814

Is this focused on maintainers AND projects or just projects? I look at CONTRIBUTING.md files as a maintainer a lot.

chris-short avatar Feb 02 '22 19:02 chris-short

Is this focused on maintainers AND projects or just projects? I look at CONTRIBUTING.md files as a maintainer a lot.

I read this as just "people" but not necessarily disqualifies other projects.

christianh814 avatar Feb 02 '22 19:02 christianh814

Per meeting on 2022-02-02, this is meta so hang on tight...

We discussed the process for working on docs like this. We know from experience when we start working on docs as a PR leads to a lot of confusion. To mitigate confusion, we're suggesting the following (which will also need to land in this doc as well).

  1. Create an issue stating the problem, thing trying to be accomplished, etc. and include a link to a HackMD doc that we can comment/edit.
  2. Once the doc is in a fairly stable state, it should become a PR (with mention of the issue) with the intention of simple edits. If it becomes a lot of back and forth, go back to the HackMD and bring in updates once sorted out.
  3. Once the doc is finalized and there are no more standing issues the PR is eligible to be merged barring any concerns/objections. (we probably need some lightweight criteria for what is a starter vs. non-starter; which I think is lightly touched on in this doc).

With that being said, @moshloop would you mind creating an issue and HackMD accordingly so we can work on the doc more collaboratively?

chris-short avatar Feb 02 '22 19:02 chris-short

@scottrigby Thoughts?

christianh814 avatar Nov 02 '22 19:11 christianh814

It might be good to bring this in the next meeting and complete the discussion.

williamcaban avatar Mar 13 '23 23:03 williamcaban

Converted this PR to a draft because it is not complete.

It might be good to bring this in the next meeting and complete the discussion.

@williamcaban yes, good idea. Just added to next week's agenda.

scottrigby avatar Mar 17 '23 05:03 scottrigby

Given all the back and forth and this is a pretty simple commit so I'll go ahead and merge it.

todaywasawesome avatar Apr 07 '23 17:04 todaywasawesome