55 lines
1.6 KiB
ReStructuredText
55 lines
1.6 KiB
ReStructuredText
Contributing Guidelines
|
|
=======================
|
|
|
|
Thank you for your interest in contributing to this cybersecurity projects repository.
|
|
|
|
How to Contribute
|
|
-----------------
|
|
|
|
Adding Project Ideas
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
If you have a cybersecurity project idea to add:
|
|
|
|
1. Fork the repository
|
|
2. Create a new markdown file in the appropriate SYNOPSES subfolder (beginner/intermediate/advanced)
|
|
3. Follow the existing format with a clear project description
|
|
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
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
To improve existing projects or documentation:
|
|
|
|
1. Fork the repository
|
|
2. Make your changes in a new branch
|
|
3. Ensure your changes are clear and well-documented
|
|
4. Submit a pull request explaining what you improved and why
|
|
|
|
Building Full Projects
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
If you want to contribute a fully built project:
|
|
|
|
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
|
|
----------
|
|
|
|
* 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
|
|
---------
|
|
|
|
If you have questions about contributing, open an issue for discussion before starting significant work.
|