Skip to content

Commit 5963f84

Browse files
authored
Create CONTRIBUTING.md
1 parent 3ee7a06 commit 5963f84

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
**If you would like to add to, modify, or improve anything in my notes, PLEASE DO!**
2+
3+
If you would like to give suggestions or even commit changes to these pages feel free to head to my GitHub page at:
4+
5+
{% embed url="https://github.com/zweilosec/Infosec-Notes" caption="" %}
6+
7+
### How to contribute
8+
9+
1. [Create an Issue Request](https://github.com/zweilosec/Infosec-Notes/issues) describing your changes/additions.
10+
2. Fork [this repository](https://github.com/zweilosec/Infosec-Notes).
11+
3. Push some code to your fork.
12+
4. Come back to this repository and [open a pull request](https://github.com/zweilosec/Infosec-Notes/pulls).
13+
5. After reviewing your changes, I will merge your pull request to the master repository.
14+
6. Make sure to update your Issue Request so that I can credit you! Thank you so much!
15+
16+
Feel free to also open an issue with any questions, help wanted, or requests!
17+
18+
Throughout these notes I have put `TODO:` notes that indicate that I know a certain section needs work. Focus on these if you can!
19+
20+
```bash
21+
TODO: Change all code examples to use variables (e.g. $host_ip)
22+
rather than fill-in-the-blank format (e.g. <host_ip>).
23+
This will help greatly with copying code directly into scripts.
24+
```

0 commit comments

Comments
 (0)