Update and rename CONTRIBUTING.md to CONTRIBUTING.rst
This commit is contained in:
parent
5b2441d2b9
commit
bf88fda3bb
|
|
@ -1,10 +1,13 @@
|
|||
# Contributing Guidelines
|
||||
Contributing Guidelines
|
||||
=======================
|
||||
|
||||
Thank you for your interest in contributing to this cybersecurity projects repository.
|
||||
|
||||
## How to Contribute
|
||||
How to Contribute
|
||||
-----------------
|
||||
|
||||
### Adding Project Ideas
|
||||
Adding Project Ideas
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you have a cybersecurity project idea to add:
|
||||
|
||||
|
|
@ -14,7 +17,8 @@ If you have a cybersecurity project idea to add:
|
|||
4. Update the main README.md to include a link to your new project
|
||||
5. Submit a pull request with a clear description of your addition
|
||||
|
||||
### Improving Existing Content
|
||||
Improving Existing Content
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To improve existing projects or documentation:
|
||||
|
||||
|
|
@ -23,27 +27,28 @@ To improve existing projects or documentation:
|
|||
3. Ensure your changes are clear and well-documented
|
||||
4. Submit a pull request explaining what you improved and why
|
||||
|
||||
### Building Full Projects
|
||||
Building Full Projects
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you want to contribute a fully built project:
|
||||
|
||||
1. Create the project in the `/PROJECTS` directory
|
||||
1. Create the project in the ``/PROJECTS`` directory
|
||||
2. Include complete source code and documentation
|
||||
3. Add a detailed README in the project folder
|
||||
4. Ensure the code follows security best practices and fully linted
|
||||
5. Submit a pull request
|
||||
|
||||
## Guidelines
|
||||
Guidelines
|
||||
----------
|
||||
|
||||
- Keep descriptions concise and technical
|
||||
- Focus on practical, educational value
|
||||
- Ensure all projects are legal and ethical
|
||||
- Test any code before submitting
|
||||
- Follow existing formatting conventions
|
||||
- Write clear commit messages
|
||||
* Keep descriptions concise and technical
|
||||
* Focus on practical, educational value
|
||||
* Ensure all projects are legal and ethical
|
||||
* Test any code before submitting
|
||||
* Follow existing formatting conventions
|
||||
* Write clear commit messages
|
||||
|
||||
## Questions
|
||||
Questions
|
||||
---------
|
||||
|
||||
If you have questions about contributing, open an issue for discussion before starting significant work.
|
||||
|
||||
<img width="683" height="670" alt="image" src="https://github.com/user-attachments/assets/7c41efdc-b8d8-4a05-983d-29b5b435e613" />
|
||||
Loading…
Reference in New Issue