[MyMeta] Add Architecture Diagram (#806)

This commit is contained in:
W.J.H
2021-09-06 16:11:29 -04:00
committed by GitHub
parent 45dd5b6d74
commit d5c1117125
4 changed files with 4706 additions and 8 deletions

View File

@@ -17,22 +17,22 @@ See [this document](https://docs.google.com/document/d/1MQX_SVndyXrHazzSN6MyfwxW
## I'm in! How do I proceed?
We have two development workflows, depending on if you have joined our [GitHub organization](<(https://github.com/MetaFam)>) yet:
We have two development workflows, depending on if you have joined our [GitHub organization](https://github.com/MetaFam) yet:
### The development flow for new builders:
1. Go to the [Issues board](https://github.com/MetaFam/TheGame/issues) here. At the top are a few pinned issues. These are the highest priority. Ideally, work on one of these; otherwise, scroll through to choose another of your fancy.
1. Clone this repo from the `develop` branch and fire up your editor of choice!
- Ask questions in the #🏗-builders-guild in our [Discord](https://discord.gg/63CPM9nQAZ) server
- Or, join our [weekly Builder's call](https://calendar.google.com/calendar/u/0/embed?src=nih59ktgafmm64ed4qk6ue8vv4@group.calendar.google.com&ctz=Europe/Belgrade) on Discord, weekly at 7a PT / 10a ET / 4p CET
1. Once you're done, create a [Pull Request (PR)](https://github.com/MetaFam/TheGame/pulls) via GitHub. _Include the issue number when filling in the description._ This is critical
- Or, join our [weekly Builder's call](https://calendar.google.com/calendar/u/0/embed?src=nih59ktgafmm64ed4qk6ue8vv4@group.calendar.google.com&ctz=Europe/Belgrade) on Discord, weekly at 7a PT / 10a ET / 4p CET _(Come half an hour early for a new builders meet-and-greet.)_
1. Once you're done, create a [Pull Request (PR)](https://github.com/MetaFam/TheGame/pulls) via GitHub. _Include the issue number when filling in the description._ This is critical.
- We use Vercel to automatically deploy the `web` package of PR branches. This is quite useful for pointing folks to a live version of your code, but only works if there are no dependent changes in backend code.
- If your PR is under your own repository (rather than [MetaFam](https://github.com/MetaFam)), someone will have to manually approve this deployment.
1. Your PR should be reviewed within a couple days and either approved or rejected with requested changes.
- No worries if your PR gets rejected! Reviewers are overwhelmingly polite and gracious, and we're appreciative of any good-faith contribution.
1. Upon approval and merge, your code will be deployed at https://test.metagame.wtf. We do merges to master periodically, depending on the complexity of merged changes (and thus need for subsequent testing).
1. Upon approval and merge, your code will be deployed at [test.metagame.wtf](https://test.metagame.wtf). We do merges to master periodically, depending on the complexity of merged changes (and thus need for subsequent testing).
- After a few merged PRs, ask to join the MetaFam organization, and use the development flow
1. All of this will earn you XP, which is updated daily on your player card at https://my.metagame.wtf.
1. All of this will earn you XP, which is updated daily on your player card at [my.metagame.wtf](https://my.metagame.wtf).
### The development flow for existing builders / members of `MetaFam`:

View File

@@ -314,7 +314,7 @@ In theory this gives applications time to move onto stable new contracts without
> Old names SHALL NOT be reused by new features.
Ah, yes, the joy when ZeroMQ v3.x renamed the top-used API functions (zmq_send\[3\] and zmq_recv\[3\]) and then recycled the old names for new methods that were utterly incompatible (and which I suspect few people actually use). You should be slapping yourself in confusion again, but really, this is what happened and I was as guilty as anyone. After all, we did change the version number! The only benefit of that experience was to get this rule.
Ah, yes, the joy when ZeroMQ v3.x renamed the top-used API functions (`zmq_send\[3\]` and `zmq_recv\[3\]`) and then recycled the old names for new methods that were utterly incompatible (and which I suspect few people actually use). You should be slapping yourself in confusion again, but really, this is what happened and I was as guilty as anyone. After all, we did change the version number! The only benefit of that experience was to get this rule.
Project Administration
----------------------
@@ -342,8 +342,8 @@ Now and then, your projects will attract people of the wrong character. You will
License and Further Reading
=======
The C4, along with this breakdown of it, was created (primarily) by the late Pieter Hintjens. If the C4 interests you it's a very good idea to check out Pieter's blog and watch his videos to get a deep understanding of his research into this field. Here's a good one to start with: [How Conway's law is eating your job](https://www.youtube.com/watch?v=7HECD3eLoVo).
The C4, along with this breakdown of it, was created (primarily) by the late Pieter Hintjens. If the C4 interests you it's a very good idea to check out Pieter's blog and watch his videos to get a deep understanding of his research into this field. Here's a good one to start with: [How Conway's law is eating your job.](https://www.youtube.com/watch?v=7HECD3eLoVo)
The text on this page is Copyright (c) 2007-2014 iMatix Corporation and Contributors, 2017-2018 Blockrazor and Contributors and is released under [CC-BY-SA-4](https://creativecommons.org/licenses/by/4.0/)
This breakdown and description of the C4 is an excerpt from [chapter 6 of _ØMQ - The Guide_](http://zguide.zeromq.org/page:all#The-ZeroMQ-Process-C), which is maintained at [booksbyus/zguide on github](https://github.com/booksbyus/zguide/blob/master/chapter6.txt).
This breakdown and description of the C4 is an excerpt from [chapter 6 of _ØMQ - The Guide_](http://zguide.zeromq.org/page:all#The-ZeroMQ-Process-C), which is maintained at [booksbyus/zguide on github](https://github.com/booksbyus/zguide/blob/master/chapter6.txt).

9
guides/README.md Normal file
View File

@@ -0,0 +1,9 @@
# MyMeta Development Guides
![architecture](architecture.svg)
- [Contributions Guide](CONTRIBUTING.md)
- [Frontend](FRONTEND.md)
- [Backend](BACKEND.md)
- [Collective Code Construction Contract (C4)](C4.md)
- [C4 With Discussion](DESCRIPTIVE_C4.MD)

4689
guides/architecture.svg Normal file

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 195 KiB