Skip to content

Commit bf88fda

Browse files
Update and rename CONTRIBUTING.md to CONTRIBUTING.rst
1 parent 5b2441d commit bf88fda

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

CONTRIBUTING.md renamed to CONTRIBUTING.rst

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
# Contributing Guidelines
1+
Contributing Guidelines
2+
=======================
23

34
Thank you for your interest in contributing to this cybersecurity projects repository.
45

5-
## How to Contribute
6+
How to Contribute
7+
-----------------
68

7-
### Adding Project Ideas
9+
Adding Project Ideas
10+
~~~~~~~~~~~~~~~~~~~~
811

912
If you have a cybersecurity project idea to add:
1013

@@ -14,7 +17,8 @@ If you have a cybersecurity project idea to add:
1417
4. Update the main README.md to include a link to your new project
1518
5. Submit a pull request with a clear description of your addition
1619

17-
### Improving Existing Content
20+
Improving Existing Content
21+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
1822

1923
To improve existing projects or documentation:
2024

@@ -23,27 +27,28 @@ To improve existing projects or documentation:
2327
3. Ensure your changes are clear and well-documented
2428
4. Submit a pull request explaining what you improved and why
2529

26-
### Building Full Projects
30+
Building Full Projects
31+
~~~~~~~~~~~~~~~~~~~~~~
2732

2833
If you want to contribute a fully built project:
2934

30-
1. Create the project in the `/PROJECTS` directory
35+
1. Create the project in the ``/PROJECTS`` directory
3136
2. Include complete source code and documentation
3237
3. Add a detailed README in the project folder
3338
4. Ensure the code follows security best practices and fully linted
3439
5. Submit a pull request
3540

36-
## Guidelines
41+
Guidelines
42+
----------
3743

38-
- Keep descriptions concise and technical
39-
- Focus on practical, educational value
40-
- Ensure all projects are legal and ethical
41-
- Test any code before submitting
42-
- Follow existing formatting conventions
43-
- Write clear commit messages
44+
* Keep descriptions concise and technical
45+
* Focus on practical, educational value
46+
* Ensure all projects are legal and ethical
47+
* Test any code before submitting
48+
* Follow existing formatting conventions
49+
* Write clear commit messages
4450

45-
## Questions
51+
Questions
52+
---------
4653

4754
If you have questions about contributing, open an issue for discussion before starting significant work.
48-
49-
<img width="683" height="670" alt="image" src="https://github.com/user-attachments/assets/7c41efdc-b8d8-4a05-983d-29b5b435e613" />

0 commit comments

Comments
 (0)