Skip to content

Commit

Permalink
Read me and pr template
Browse files Browse the repository at this point in the history
  • Loading branch information
merrickliu888 committed Nov 3, 2024
1 parent d28ac50 commit 5511779
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 8 deletions.
22 changes: 22 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Description

[Linear Ticket]() <!-- Put URL of Linear Ticket in parentheses -->

<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change: -->

## 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
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5511779

Please sign in to comment.