Your project's readme is as important to success as your code. For
this reason you should put as much care into its creation and maintenance
as you would any other component of the application.
If you are unsure of what should go into the readme let this article,
written by an experienced Chingu, be your starting point -
Keys to a well written README.
And before we go there's "one more thing"! Once you decide what to include
in your readme feel free to replace the text we've provided here.
Own it & Make it your Own!
You may find these helpful as you work together to organize your project.
Meeting Agenda templates (located in the /docs directory in this repo):
- Meeting - Voyage Kickoff --> ./docs/meeting-voyage_kickoff.docx
- Meeting - App Vision & Feature Planning --> ./docs/meeting-vision_and_feature_planning.docx
- Meeting - Sprint Retrospective, Review, and Planning --> ./docs/meeting-sprint_retrospective_review_and_planning.docx
- Meeting - Sprint Open Topic Session --> ./docs/meeting-sprint_open_topic_session.docx
Everyone on your team should add their name along with a link to their GitHub & optionally their LinkedIn profiles below. Do this in Sprint #1 to validate your repo access and to practice PR'ing with your team before you start coding!