Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 2.6 KB
Raw

Contributing

We welcome contributions to the Cansleep project from individuals who are passionate about enhancing the tool's functionality, security, and educational value. Your contributions can help make this project even more valuable for educational and research purposes. Here's how you can get involved:

  1. Reporting Issues: If you come across any bugs, vulnerabilities, or issues in the tool, please open a new issue on the project's GitHub repository. Be sure to provide a detailed description of the problem, including steps to reproduce it, and any relevant system information.

  2. Feature Requests: If you have ideas for new features or improvements to the tool, feel free to create a feature request on the GitHub repository. Provide a clear description of the feature and its potential benefits.

  3. Code Contributions: If you are a developer and would like to contribute code to the project, we encourage you to submit pull requests. Follow these guidelines when making contributions:

  • Fork the repository and create a new branch for your changes.
  • Ensure your code adheres to the project's coding standards.
  • Include tests for new features and fixes.
  • Provide clear documentation for any new functionality.

  1. Documentation: Improving documentation is always valuable. If you can enhance the project's documentation by adding more details, guides, or examples, please submit documentation-related pull requests.

  2. Testing: Help test the tool on different platforms and provide feedback on its performance. This includes testing compatibility with various operating systems, network environments, and camera systems.

  3. Security: If you discover security vulnerabilities or issues that could impact the security of the tool, please follow responsible disclosure practices and contact the project maintainers privately before disclosing them publicly.

  4. Support and Discussion: Engage with the project's community by participating in discussions, answering questions, and helping other users. This can be done through the project's issue tracker and forums.

Getting Started: Before making any contributions, please review the project's contribution guidelines and code of conduct. These guidelines provide important information on how to contribute, maintain a positive and inclusive environment, and adhere to ethical practices.

By contributing to the Cansleep, you are playing a vital role in improving the educational resources and security of urban surveillance systems. We appreciate your support and look forward to your valuable contributions.

Thank you for being a part of this educational and security-focused community!