Athens: Create FAQ, Guidelines For Athens

[devdinu]

We could use go FAQ as a reference.

1. What's the purpose of the project, what does it solve.
2. Architectural Decisions (this could be separate too)
3. Conventions for code PR's Effective Go helps at high level, this is very customised
4. For each package
5. the way we pull out interfaces
6. errors, logging, tracing
7. benchmark

The faq is helpful for newcomer to understand, and the guidelines will help folks to create a better PR with less conversation, and making review effective.

[michalpristas]

I will prepare something.
Im just going to poll a survey here: about architectural decisions, what format do you prefer?

I was thinking about some overview of current state followed by Decision log - explaining how we got there in form of short tweets (?), so it's clear what was rejected on the way
@arschles @bketelsen @robjloranger @devdinu

[robjloranger]

I like this @michalpristas, starting with overview of the current state. How we ended up there.

[arschles]

@michalpristas for current state and architectural decisions, do you think that REGISTRY.md and PROXY.md can be updated?

[michalpristas]

yes i was planning to draw some communication diagrams, more detailed models maybe
+history what we've been through ever since 3-phase-commit model

[michalpristas]

@robjloranger FAQ and WALKTHROUGH are done right. can we close

[arschles]

@devdinu given what you see on https://docs.gomods.io, do you think everything you were asking for is written down clearly?

[manugupt1]

Closing this as we have FAQs and walkthrough now