Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (50 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

71 lines (50 loc) · 2.45 KB

Contributing to Redirect Analyzer Tool

Thank you for your interest in contributing to the Redirect Analyzer Tool!

Before you start, please take a moment to read through these guidelines to ensure that your contributions align with the project's goals and standards.

🛠 How to Contribute

We welcome all kinds of contributions:

  • Bug fixes
  • New features (if aligned with the project scope)
  • Documentation improvements
  • UI/UX enhancements
  • Testing and reporting issues

Here’s how to get started:

  1. Fork the repository
  2. Create a new branch:
    Use a descriptive name like fix/bug-description or feature/new-functionality
  3. Make your changes
  4. Test your changes thoroughly
  5. Commit your changes with clear and concise commit messages
  6. Push your branch to your forked repo
  7. Open a Pull Request, explaining what your contribution does and why it should be merged

📜 Code Style

To keep the codebase clean and readable, please follow these style guidelines:

  • Use PEP8-compliant Python formatting (indentation, spacing, etc.)
  • Keep functions modular and well-documented
  • Add comments where needed to explain complex logic

Avoid:

  • Hardcoding values without explanation
  • Making unnecessary global variables
  • Overwriting existing functionality without discussion

🧪 Testing

All new features and bug fixes must be tested before submission. If applicable, include:

  • Unit tests
  • Screenshots of UI changes
  • Example redirects used during testing

📬 Reporting Issues

If you find a bug or have an idea for improvement:

  1. Check if the issue has already been reported in the GitHub Issues
  2. If not, open a new issue with a clear and detailed description
  3. Include:
    • Steps to reproduce
    • Expected vs actual behavior
    • Screenshots, logs or error messages (if relevant)

🤝 Code of Conduct

Please note that this project follows a Code of Conduct. All contributors are expected to adhere to it. Be respectful and collaborative in your communication.

📚 License Notice

This project is licensed under GNU GPL v3.0. By contributing, you agree that your contributions will be distributed under the same license.

❤️ Thank You

Your help is greatly appreciated! Every contribution makes the tool more useful for everyone.

For questions or feedback, feel free to reach out via an issue or pull request.

Happy coding!