Merge pull request #1 from AmanTahiliani/AmanTahiliani-README-update

Project PR guidelines
This commit is contained in:
Aman Tahiliani
2024-03-12 13:03:18 -04:00
committed by GitHub

View File

@@ -1 +1,10 @@
# PeerNotes
# PeerNotes (In Progress)
Repository for a course project of CS4675/CS6675 at Georgia Institute of Technology.
## Advisory for Contributors
<ul>
<li>Please do not commit any code to the main branch directly</li>
<li>Use feature branches, ideally with your name and the feature it is for mentioned in the branch name eg. feature_aman_login</li>
<li>Raise a PR once you are ready and have checked your code for errors.</li>
<li>Mention a bullet point summary for all the features you are pushing as part of the PR within the description to ease the review process</li>
</ul>