Thank you for considering contributing to Cyberbro! This guide will help you get started.
- Check if the issue is already reported.
- Open a GitHub Issue with a clear description and steps to reproduce the problem.
- Open a GitHub Issue with the "enhancement" label.
- Describe the feature, its benefits, and how it aligns with the project goals.
- Fork the repository and create a feature branch (
git checkout -b feature/my-feature). - Write clear, concise code that adheres to the project's style.
- Ensure all tests pass before submitting.
- Submit a pull request to the
mainbranch and describe your changes.
- Improve existing documentation or write new content for new features.
- Ensure documentation is clear, concise, and easy to follow.
- Add tests for your changes to ensure quality and stability.
- Use sample observables to validate the functionality.
- Use Python 3.11 or later.
- Follow snake_case coding style
- Keep dependencies minimal and document any new ones in
requirements.txt.
- Be respectful and constructive in discussions.
- Avoid unrelated self-promotion.
- Strive to make Cyberbro better for all users.
We appreciate your contributions and efforts to improve Cyberbro. Together, we can make this tool even more powerful!
Maintainer: stanfrbd