use this starter repository: Markdown template repository
Find a time to meet with your study group and build a get-to-know-you repository with one markdown file per person in your group. This doesn’t need to be anything fancy. Your focus should be on getting to know each other and learning to work on a shared repository.
When you’re ready to start your group repo, create a new issue in the class repo
using the deliverable template and add the group label. Fill out the
project’s description, list your group members, and paste this checklist into
your issue before
adding it to the Class Projects board:
PS. check out other HYF classes for inspiration
For your group’s deliverable issue in the class repo:
<!-- replace the _ with the correct user name and repo -->
- [ ] [repo](https://github.com/_/_)
- [ ] [many small, well-named commits](https://github.com/_/_/commits)
- [ ] a nice README
- [ ] one well-named file per person
- [ ] [one pull requests for each group member](https://github.com/_/_/pulls)
- [ ] linting checks pass
- [ ] code review checklist is complete
- [ ] the reviewer merged the code
For your individual PRs in your group repository
- Setup: GitHub
- [ ] created this issue
- [ ] assigned myself
- [ ] moved the issue to the project board
- Setup: local
- [ ] pulled the most recent code from `main`/`master`
- [ ] created a new branch for my introduction
- Writing the content:
- [ ] added my intro file in `/people` according to group conventions
- [ ] linked to my file from `/README.md` according to group conventions
- Before pushing my branch:
- [ ] formatted the code
- [ ] fixed all spelling mistakes and added new words to the dictionary
- [ ] fixed all linting mistakes
- After pushing my branch:
- [ ] created a new PR linked to this issue
- [ ] make sure all of the checks passed
- [ ] assigned someone to review and merge my PR