From 55117797f63ec40c03997dc6c96c177557d47fdc Mon Sep 17 00:00:00 2001 From: merrickliu888 Date: Sun, 3 Nov 2024 18:07:28 -0500 Subject: [PATCH] Read me and pr template --- .github/pull_request_template.md | 22 ++++++++++++++++++++++ README.md | 20 ++++++++++++-------- 2 files changed, 34 insertions(+), 8 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..8b124d7c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,22 @@ +## Description + +[Linear Ticket]() + + + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# Checklist: + +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation (if required) +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works diff --git a/README.md b/README.md index 6eeae841..6cfc3fa1 100644 --- a/README.md +++ b/README.md @@ -19,19 +19,23 @@ Menstruation Nation is now available to everyone on [Google Play Store](https:// ## Use cases -* Select a single or multiple symptoms to track, symptoms include Flow, Mood, Sleep, Cramps, Exercises -* See logs on a chosen symptom -* Click on any day to log a symptom -* See calculated statistics including average period length or predicted days until next period -* Educational page displaying menstruation products and educational facts -* No registration required -* Completely wipe data at any given point -* Back-up data with Google Firebase +- Select a single or multiple symptoms to track, symptoms include Flow, Mood, Sleep, Cramps, Exercises +- See logs on a chosen symptom +- Click on any day to log a symptom +- See calculated statistics including average period length or predicted days until next period +- Educational page displaying menstruation products and educational facts +- No registration required +- Completely wipe data at any given point +- Back-up data with Google Firebase ## Contributors This project would not be possible without the combined efforts of the TPP Blueprint team: +2024-2025: +[Merrick Liu](https://github.com/merrickliu888), [Paridhi Goel](https://github.com/paridhi26), [Patricia Santos](https://github.com/santoaast) + +2023-2024: [Leo Liu](https://github.com/leowrites), [Manpreet Bhatti](https://github.com/Manpreet-Bhatti), [Manya Mittal](https://github.com/manya-mittal), [Madeline Ahn](https://github.com/madelahn), [Kevin Le](https://github.com/kevinle623), [Elena Wang](https://github.com/elenawzy), [Michael Ng](https://github.com/michaelng0107), [Pierre-William Lessard](https://github.com/PierreLessard), [Yuwei Jiang](https://github.com/Jyw5599) ## Contributing