-
Notifications
You must be signed in to change notification settings - Fork 27
Description
Please place a document at the repo root named START_HERE.md, if it exists overwrite it. In it please address the following: - What is this repo for? Describe it to any human that's looking at the repo for the first time. - Why is this repo being built/why is this useful? - Who is it for? Describe who would be interested in this repo and why - Repo Deep Dive: give a deep dive into the repository at the level of a developer. Don't assume specific language skills but assume a skilled developer is reading this. However, that doesn't mean you can be vague, don't be vague. Explain the project, how it is being developed, anything unique about the code in it, and how technically it accomplishes what it does. Be candid and straightforward, no need to make it sound great, this is for a team member. Finally address this: How would someone build on this? List items that could be fixed or done in the repo starting with 'easy' to moderate to difficult. Point out important places of code. Make sure someone can use this guide to actually navigate the repo and get started!