magma / community

Magma community documentation and processes
BSD 3-Clause "New" or "Revised" License
8 stars 11 forks source link

Rewrite all github.com/magma/community documents and community-related documents in the magma repository. #19

Closed lucasgonze closed 2 weeks ago

lucasgonze commented 3 months ago

Most of the governance documents should live in the magma/community repository, not in the magma/magma repository, which is for code. However the community repo:

  1. Has been archived since 2022
  2. Hasn't been updated in a long time
  3. Needs to host the charter

Tasks:

lucasgonze commented 3 months ago

As I get deeper into the project I am rethinking it. The documents in the community repo are years behind the documents in the magma repo. What I should do is

  1. review every community-related document in the magma repo
  2. update the text of the README in the community repo to explain that the contents are useless
  3. unarchive the community repo
  4. verify that all files in the community repo also exist in the magma repo
lucasgonze commented 3 months ago

Review each of the following:

Dup of file in magma repo. Out of date. Proposed resolution: possibly this file, then rearchive community repo.

Dup of file in magma repo. Out of date. Proposed resolution: possibly this file, then rearchive community repo.

This file is missing from the magma repo. Maybe it should be copied over to that repo. (But first verify that this information isn't elsewhere already).

Good information about project social structures. Should be part of governance documentation. Consolidate with info in community/Governance.md

Self-evident information, probably from a very early stage of the project. Delete file before rearchiving.

Dup of file in magma repo. Out of date. Proposed resolution: possibly this file, then rearchive community repo.

Badly broken. For some reason TSC governance information is in there. This needs a complete rewrite.

Merge this information into the README, then delete this file.

Rethink these items:

lucasgonze commented 2 months ago

Resolved: use a monorepo instead of a multirepo.

lucasgonze commented 2 months ago

Code of conduct files have only a trivial syntax difference.

lucasgonze commented 2 months ago

CONTRIBUTING.md:

The goop in magma/CONTRIBUTING is the technical charter, as Kendall called it at the time. Need to figure out where that really goes.

Prior art for good CONTRIBUTING files:

lucasgonze commented 2 months ago

WTF: there also exists a repo called https://github.com/magma/Governance

lucasgonze commented 2 months ago

The state of this list is a mess. I need to re-review and document every item.

lucasgonze commented 2 weeks ago

Archived /magma/community repo

lucasgonze commented 2 weeks ago

All remaining items have been reviewed and either implemented or I have decided they were defined before I full understood the project structure.