Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
3 of 5 tasks
lucasgonze opened this issue Mar 28, 2024 · 9 comments
Assignees

Comments

@lucasgonze
Copy link
Contributor

lucasgonze commented Mar 28, 2024

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:

  • Unarchive
  • Check each document for stale data
  • Update TSC membership listing
  • Migrate charter into this repository
  • Move community-related documents in the magma repo to the community repo
@lucasgonze lucasgonze self-assigned this Mar 28, 2024
@lucasgonze
Copy link
Contributor Author

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
Copy link
Contributor Author

lucasgonze commented Mar 28, 2024

Review each of the following:

  • ../community/CODE_OF_CONDUCT.md

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

  • ../community/CONTRIBUTING.md

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

  • ../community/Governance.md

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).

  • ../community/Organization_of_Work.md

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

  • ../community/README.md

  • Check that this info is all in the magma/README.md file.

  • Rewrite to explain that the community repo is no longer where these documents live.

  • Rearchive community repo.

  • ../community/Reviewing.md

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

  • ../magma/CODE_OF_CONDUCT.md

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

  • ../magma/CONTRIBUTING.md

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

  • ../magma/DCO.md

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

  • ../magma/README.md
  • ../magma/REWARDS_PROGRAM.md

Rethink these items:

  • Weighted Voting

  • List Of Reward Eligible GIthub Issues

  • ../magma/SECURITY.md

  • Check that this is in sync with https://github.com/magma/magma/security/policy. Consider removing magma/SECURITY.md file to be sure they can't get out sync.

  • Read the details to be sure they are still accurate

@lucasgonze
Copy link
Contributor Author

Resolved: use a monorepo instead of a multirepo.

@lucasgonze
Copy link
Contributor Author

Code of conduct files have only a trivial syntax difference.

@lucasgonze
Copy link
Contributor Author

lucasgonze commented Apr 9, 2024

CONTRIBUTING.md:

  • big differences between the repos
  • the version in the magma repo is much more up to date
  • version in the magma repo is badly broken. For some reason TSC governance information is in there. This needs a complete rewrite.

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
Copy link
Contributor Author

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

@lucasgonze
Copy link
Contributor Author

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

@lucasgonze
Copy link
Contributor Author

Archived /magma/community repo

@lucasgonze
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant