Skip to content

Instantly share code, notes, and snippets.

@vini-btc
Last active April 7, 2019 19:32
Show Gist options
  • Save vini-btc/eb6efdb01a5ac910942b072d15fffb06 to your computer and use it in GitHub Desktop.
Save vini-btc/eb6efdb01a5ac910942b072d15fffb06 to your computer and use it in GitHub Desktop.
Code architecture meetings guidelines
Topics to be discussed should pass the following requirements:
1. Clear description
It should clearly describe what the issue is about, stating the goal of discussing that topic and if possible
propose a set of action points.
2?. A tag
We currently don't have'em, but we could. "App structure", "React best practices", "Types", "Tests", etc.
3. A concrete example of the issue being discussed and/or the solution being proposed. This could be:
- A gist with the example
- An extract of the code from our codebase
- An extract of code from other sources
- A wip/dummy/sample PR with a proposal
- Highlights of an article or book.
4. An assignee. A person that will be responsible for presenting the topic, usually the creator.
5?. An ACK of all members on the topic card, represented by a comment.
As in: reporter of the card pokes people to check it. If one member agrees that the card is relevant
and that the other requirements were met, that member would go to the card and state this on a comment
on that card (adding an "Acked" comment there, for example).
@mloureiro
Copy link

Part of my motivation behind proposing it is trying to make some more shared ownership happen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment