Commit 4c35188
feat: adds contributing markdown (#75)
Closes #68
### Overview
Adds the CONTRIBUTING.md file to the repo. Includes a Quick Start guide
on how to set up the repo, install dependencies, and go through the rest
of the setup. Includes Development Guidelines with a link to the
STYLE_GUIDE.md
### Testing
_No testing_
### Screenshots / Screencasts
Preview of the markdown file (it's 3 pictures, sorry for the
formatting):
<img width="832" height="753" alt="contributing_1"
src="https://github.com/user-attachments/assets/748a16ae-2a29-46f5-941d-f0724128cc05"
/>
<img width="826" height="814" alt="contributing_2"
src="https://github.com/user-attachments/assets/1d951a42-739a-48a6-96b2-f613fecb8991"
/>
<img width="831" height="820" alt="contributing_3"
src="https://github.com/user-attachments/assets/e6526c74-ffe8-4ba1-882f-37a46c04898f"
/>
### Checklist
- [x] Code is neat, readable, and works
- [x] Code is commented where appropriate and well-documented
- [x] Commit messages follow our
[guidelines](https://www.conventionalcommits.com)
- [x] Issue number is linked
- [x] Branch is linked
- [ ] Reviewers are assigned (one of your tech leads)
Tip: You can make the issue and then check them after the fact or
replace `[ ]` with `[x]` to check it!
### Notes
Not sure if the STYLE_GUIDE.md is supposed to be incorporated into the
CONTRIBUTING.md file or if just linking it is sufficient. Also, much of
the content was taken from this repo's README.md and Cal Poly's H4I
repo, so let me know if something doesn't make sense or conform to
Operation's standards.
---------
Signed-off-by: Sophia Chang <[email protected]>
Co-authored-by: Sophia Chang <[email protected]>1 parent 59a0cdb commit 4c35188
1 file changed
+111
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
0 commit comments