Thank you for your interest in contributing to Code Arsenal! We appreciate your efforts to enhance software security and collaborate with the security community. This guide outlines the steps to contribute effectively.
Before you start contributing, please familiarize yourself with the following guidelines:
- Fork the Code Arsenal repository from https://github.com/CodeArsenalCommunity/codearsenalcommunity.github.io to your own GitHub account.
- Clone your forked repository to your local development environment:
git clone https://github.com/<YOUR_USERNAME>/codearsenalcommunity.github.io.git-
Create a new post under the _posts folder with the following naming convention: ---<POST_NAME>.md, for example: 2018-01-12-fixing-ssrf-in-python.md
-
Use your preferred Markdown editor or the GitHub editor to create a well-structured Markdown file for your contribution.
-
Ensure your Markdown file includes the necessary information, such as tags, to provide context for your contribution. Tags may include programming language, vulnerability name, and topic name.
-
Introduce multiple approaches to fix the same vulnerability if you know them. You may also include other supporting details, such as how to monitor the vulnerability, what automation can be created, and what tools or network-level rules can be utilized (e.g., Cloudflare, WAF) to mitigate or prevent these vulnerabilities.
If you are contributing for the first time, please add your profile details under the author tag in _config.yml
Once you have completed your contribution:
- Commit and push your changes to your forked repository.
- Raise a Pull Request against the main branch of CodeArsenalCommunity/codearsenalcommunity.github.io.
- One of our maintainers will review and approve your Pull Request.
Thank you for your valuable contribution! Together, we can make a significant impact on software security.