Welcome to Egyscan! We're excited that you're interested in contributing to our Security Vulnerability Scanner. Before you get started, please take a moment to read through this guide to ensure a smooth and collaborative contribution process.
Please review our Code of Conduct before contributing. We want to create a respectful and inclusive environment for all contributors.
Contributions can start with GitHub Issues. Look for issues labeled "help wanted" or "good first issue" to find tasks suitable for newcomers.
If you find a new issue or want to suggest an enhancement, please create a new issue. Provide as much detail as possible to help us understand the problem or feature request.
- Fork the repository and create a new branch for your contribution.
- Make your changes, following the Style Guide and ensuring the code passes Testing.
- Submit a pull request (PR) to the
mainbranch. Provide a clear and concise description of your changes and reference the relevant issue if applicable. - Your PR will be reviewed by maintainers. Be prepared to address any feedback or suggested changes.
Please follow our coding and formatting standards to maintain consistency within the project. Details can be found in STYLE_GUIDE.md.
Before submitting your contribution, make sure that your changes pass all tests. Provide appropriate tests if applicable. More details are available in TESTING.md.
Join us on GitHub Discussions to share your ideas, ask questions, and participate in project-related discussions.
By contributing, you agree that your contributions will be licensed under the LICENSE of this project.
Thank you for your interest in contributing to Egyscan Security Vuln Scanner! Your contributions help make this project better for everyone.