We maintain the documents in this repo to help team members understand and help define...
- what we do
- how we do it — e.g., practices, standards, tools, etc.
- why/how we made these decisions — via commit history, Pull Requests & comments, etc.
-
read the contribution guidelines for more information
-
watch this repo to be notified of conversations, proposals, etc. via e-mail so you can decide if/when you wish to participate!
In short, you can think of them as
- I Think… ⇒ wiki
- We Agree… ⇒ repo
Based, in part, on this presentation and its slides, things in the repo are cultural 'norms', standards, and practices; things which deserve and require discussion and agreement to change.
In contrast, the wiki is a great place to collect and share things which do not require/deserve discussion and agreement — ideas, resources, etc.
Please add and maintain information in the wiki, adding and editing pages as needed!
Please read through these files/documents.
Just as importantly, please help us improve them. Right now, you are our best expert on being a new-hire.
If you have any questions please
- ask someone
- create a branch and submit a Pull Request (PR) with your improvement(s)
Your changes will help future new-hires (and all of us!) be more successful more quickly!
Please refer back to these documents on a regular basis and help keep them up-to-date.
- add new information, practices, standards, etc.
- update things we've changed
- remove things that aren't relevant any more
If you're not sure, ask other team members — we're all in this together!