LibreCrawl/CONTRIBUTING.md

Contributing

Thanks for considering contributing to LibreCrawl. Here's how you can help.

Ways to contribute

• Report bugs: If something doesn't work, open an issue
• Suggest features: Ideas for improvements are welcome
• Fix issues: Browse open issues and submit pull requests
• Improve docs: Help make the documentation clearer

Getting set up

1. Fork the repository
2. Clone your fork locally
3. Install dependencies: pip install -r requirements.txt
4. Make your changes
5. Test that everything still works
6. Submit a pull request

Code style

• Follow existing code patterns
• Add comments for complex logic
• Test your changes before submitting

Reporting bugs

When reporting bugs, include:

• What you were trying to do
• What happened instead
• Steps to reproduce the issue
• Your operating system and Python version
• Any error messages

Suggesting features

For feature requests:

• Explain what you want to accomplish
• Describe how you think it should work
• Consider whether it fits with the project's goals

Pull requests

• Keep changes focused on one thing
• Write a clear description of what you changed
• Include tests if applicable
• Make sure the app still runs after your changes

Questions

If you have questions about contributing, feel free to open an issue to ask.

Code of conduct

Be respectful and constructive. We want this to be a welcoming project for everyone.