trustoverip / TechArch

This is the working area for the ToIP Technology Architecture specification.
10 stars 12 forks source link

governance files: CODEOWNERS, CONTRIBUTING.md, and GOVERNANCE.md #49

Closed andorsk closed 1 year ago

andorsk commented 1 year ago

Initial governance files of CODEOWNERS, CONTRIBUTING.md, and GOVERNANCE.md. Related to issues:

https://github.com/trustoverip/TechArch/issues/40 https://github.com/trustoverip/TechArch/issues/39 https://github.com/trustoverip/TechArch/issues/38 https://github.com/trustoverip/TechArch/issues/46

These files are important for designating the repository management of the repo. A couple things:

  1. I will copy things to the wiki after, that being said, the source of truth is the repo, NOT the wiki. If things ever get out of alignment, the repo should be the single source of truth.
  2. I highlighted a few areas which are interesting/need some review.
andorsk commented 1 year ago

@a-fox can you take a look at this and give some feedback if possible.

andorsk commented 1 year ago

@talltree I'll copy the stuff over the wiki to make sure it's also documented there.

andorsk commented 1 year ago

Based on a conversation with @a-fox , we discussed prioritizing the focus of this PR as the following:

  1. Make it as easy as possible for non-tech/Git saavy people to contribute to the TechArch repository. This is covered in the documentation. In particular, make sure to check out the CONTRIBUTING.md file. This should be in a state to shared for feedback by tomorrow, and it’ll be good to hear the rest of the community on how they feel about it as it currently stands.
  2. In a separate PR: @a-fox will explore new ways which we can make it even easier for people to contribute. @Antti Kettunen is leading that charge. He was going to try and make some proposals by Thursday.

@talltree @a-fox , please review the Governance and Contributing files, and review them to give feedback.

andorsk commented 1 year ago

Maybe need to put the https://github.com/andorsk/TechArch/tree/governance#contributing into the CONTRIBUTING.md file

andorsk commented 1 year ago

Note for the basic change flow ( non git loving users ), https://github.com/trustoverip/TechArch/blob/339dc1cf4bd0c7d226520dc963a1b9726937a020/CONTRIBUTING.md#basic-change-flow is where it’s documented.

To me, this is probably the highest priority to be sufficient before opening it up to the rest of the community, as this is where most the rubber will meet the road for a lot of people. @darrellodonnell can you please pay really close attention to this and see if the flow is reasonable for you and/or provide feedback if it's not satisfactory.

andorsk commented 1 year ago

@talltree @martchcl @darrellodonnell I've added you to the reviewers. Please go through this at your convenience and add commentary or even propose changes. You can click View File to look at the rendered .md file. Thanks!

andorsk commented 1 year ago

@talltree where should the video in the Video Walkthrough: https://github.com/trustoverip/TechArch/blob/339dc1cf4bd0c7d226520dc963a1b9726937a020/CONTRIBUTING.md#basic-change-flow be hosted?

a-fox commented 1 year ago

IMO this is ready for merge.

darrellodonnell commented 1 year ago

I am happy to see a last-call here. I am also testing my CLA integration!