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

Consider splitting MSCs and spec into separate github repositories #927

Closed
richvdh opened this issue Nov 16, 2021 · 7 comments
Closed

Consider splitting MSCs and spec into separate github repositories #927

richvdh opened this issue Nov 16, 2021 · 7 comments
Assignees

Comments

@richvdh
Copy link
Member

richvdh commented Nov 16, 2021

Combining MSCs and finalised spec docs into a single repo brings several problems:

  • Pull requests have a very different lifecycle. It is hard to keep on top of non-MSC PRs, which generally get merged much quicker than MSC PRs. (It is possible to use labels to do some filtering, but I still think it means that spec PRs tend to get forgotten)
  • Having 291 open PRs is, rightly or wrongly, seen as a terrible smell for a project of this size. At least we could compartmentalise it into a single "proposals" repository.
  • I generally think it's a bit confusing for new contributors.
  • As a spec author, it's often necessary to have two checkouts for matrix-doc: one for MSCs and one for spec writing: the tooling conflicts with MSC branches.

I think my strategy to fix it would be:

@richvdh
Copy link
Member Author

richvdh commented Feb 17, 2022

close as many non-MSC matrix-doc PRs as possible (https://github.com/matrix-org/matrix-doc/pulls?q=is%3Aopen+is%3Apr+-label%3Aproposal)

there's only a handful of these, so it might be quite a good time to do this.

@turt2live
Copy link
Member

@matrix-org/spec-core-team if you have thoughts or reason to believe we shouldn't do this, please raise them imminently.

@richvdh
Copy link
Member Author

richvdh commented Mar 1, 2022

I'm going to begin this now.

@richvdh richvdh self-assigned this Mar 1, 2022
@richvdh
Copy link
Member Author

richvdh commented Mar 1, 2022

This is now largely done, and https://github.com/matrix-org/matrix-spec-proposals and https://github.com/matrix-org/matrix-spec exist.

I've got a script which is going through and transferring the issues to https://github.com/matrix-org/matrix-spec, however the github API seems to be somewhat rate-limited, so it may be a matter of days rather than hours before it completes.

Other follow-up tasks:

@turt2live
Copy link
Member

turt2live commented Mar 1, 2022

to add:

  • Convert old issue-based MSCs to PRs
  • Copy comments from old split MSCs to the PR counterpart (there are a handful of MSCs which used a process where the MSC number was the issue number and the PR would be referenced by that issue - the MSC was the issue, not the PR. We should renumber these to make the MSC the PR instead)
  • Turn off issue creation for the proposals repo (use PRs for everything)
    • but reopened, because turning issues off made all historical issues into 404s.
  • Verify the MSC bots work and are updated

@anoadragon453
Copy link
Member

anoadragon453 commented Mar 4, 2022

@richvdh
Copy link
Member Author

richvdh commented May 16, 2022

I think this is done, to a good approximation

@richvdh richvdh closed this as completed May 16, 2022
sumnerevans pushed a commit to beeper/msc-link-bot that referenced this issue Apr 28, 2023
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

3 participants