From bf88fda3bbb20227c593f81e8db58ea582157923 Mon Sep 17 00:00:00 2001 From: Carter Perez Date: Tue, 9 Dec 2025 09:22:15 -0500 Subject: [PATCH] Update and rename CONTRIBUTING.md to CONTRIBUTING.rst --- CONTRIBUTING.md => CONTRIBUTING.rst | 37 ++++++++++++++++------------- 1 file changed, 21 insertions(+), 16 deletions(-) rename CONTRIBUTING.md => CONTRIBUTING.rst (64%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.rst similarity index 64% rename from CONTRIBUTING.md rename to CONTRIBUTING.rst index 4b64c2ef..f49a7bf7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.rst @@ -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. - -image