mirror of
https://github.com/AmanTahiliani/PeerNotes.git
synced 2026-08-08 04:06:18 -04:00
Project PR guidelines
This commit is contained in:
11
README.md
11
README.md
@@ -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>
|
||||||
|
|||||||
Reference in New Issue
Block a user