We welcome contributions from the community and are pleased that you are interested in helping to improve the DNS Security Analysis Tool. This document provides guidelines and information on how you can contribute.
Please report bugs and issues using the GitHub issue tracker:
When reporting an issue, include as much detail as possible about how to reproduce the problem. If possible, include:
- The version of the tool you are using
- Steps to reproduce the issue
- Any relevant logs or error messages
- Screenshots, if applicable
If you have ideas for new features or improvements, we'd love to hear them. Please submit them as issues, using the label 'feature request'.
We actively welcome your pull requests. Here's how to get started:
-
Fork the Repo:
- Fork the repository and clone it locally. Create a branch for your edits.
-
Develop Your Changes:
- Make your changes in your forked repository.
- Follow the code style of the project, including indentation and documentation.
-
Write Tests:
- If you add new code, it should come with unit tests to verify its functionality.
- Ensure that all tests pass.
-
Ensure Your Code Passes Linting:
- Your code should follow the Python PEP 8 style guide.
-
Write Clear Commit Messages:
- Write clear, concise commit messages describing your changes.
-
Create a Pull Request (PR):
- Push your changes to your fork and open a pull request in the main repository.
- In your pull request, describe what your changes do and mention any relevant issue numbers.
-
Code Review:
- Wait for a maintainer to review your PR. If there are any comments or suggestions, please address them.
By participating in this project, you agree to abide by its terms.
By contributing to the DNS Security Analysis Tool, you agree that your contributions will be licensed under its Apache License 2.0.
Thank you for taking the time to contribute!