diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 72c52f4..d09b694 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,36 +1,25 @@ -We welcome contributions from everyone, regardless of experience level. Here are some ways you can contribute to the DDoS-Attack-Detection-and-Mitigation project: +## We welcome contributions from everyone, regardless of experience level. Here are some ways you can contribute to the DDoS-Attack-Detection-and-Mitigation project: -Report bugs. If you find a bug, please report it on GitHub. Include a detailed description of the bug, including steps to reproduce it. -Suggest new features. If you have an idea for a new feature, please create a GitHub issue to discuss it. -Improve the documentation. If you find any errors or omissions in the documentation, please submit a pull request to fix them. -Write code. If you have experience with Python and Machine Learning, you can contribute to the codebase. Please follow the coding conventions and submit pull requests for your changes. -Getting started -To get started contributing to the DDoS-Attack-Detection-and-Mitigation project, you will need to: +* Report bugs: If you find a bug, please report it on GitHub. Include a detailed description of the bug, including steps to reproduce it. +* Suggest new features: If you have an idea for a new feature, please create a GitHub issue to discuss it. +* Improve the documentation: If you find any errors or omissions in the documentation, please submit a pull request to fix them. +* Write code: If you have experience with Python and Machine Learning, you can contribute to the codebase. Please follow the coding conventions and submit pull requests for your changes. -Fork the repository. -Clone your fork to your local machine. -Install the required dependencies. -Create a new branch for your work. -Make your changes. -Test your changes. -Commit your changes and push them to your fork. -Submit a pull request to the main repository. -Coding conventions -Please follow the following coding conventions when contributing to the DDoS-Attack-Detection-and-Mitigation project: +## Getting started +### To get started contributing to the DDoS-Attack-Detection-and-Mitigation project, you will need to: -Use 4 spaces for indentation. -Use a single line break between functions and classes. -Use a double line break between top-level sections of a file. -Use snake_case for variable names and function names. -Use PascalCase for class names. -Add type hints to all variables and functions. -Add comments to your code to explain what it is doing. -Testing -Please test your changes thoroughly before submitting a pull request. You can test your changes by running the following commands: +* Fork the repository. +* Clone your fork to your local machine. +* Install the required dependencies. +* Create a new branch for your work. +* Make your changes. +* Test your changes. +* Commit your changes and push them to your fork. +* Submit a pull request to the main repository. -This will run all of the unit tests for the project. -Submitting a pull request + +## Submitting a pull request To submit a pull request, please follow these steps: Go to your fork of the repository on GitHub.