Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

72 lines (51 loc) · 2.97 KB

Contribution Guidelines

Thank you for considering contributing to this project! Contributions are welcome and appreciated. There are many ways you can contribute, from writing code, adding documentation, reporting bugs, or suggesting enhancements.

1. Reporting Bugs

If you find a bug, please open an issue and include as much detail as possible. Ensure that the issue has not been reported before by searching existing issues. A good bug report includes:

  • Summary: A concise description of the issue.
  • Steps to Reproduce: Step-by-step instructions to replicate the issue.
  • Expected Result: What you expected to happen.
  • Actual Result: What actually happened.
  • Screenshots/Logs: Any relevant screenshots or logs.

2. Suggesting Enhancements

If you have an idea for a new feature or an enhancement, please open an issue and describe:

  • Motivation: Why this feature would be useful.
  • Proposed Solution: How you would like to see this feature implemented.
  • Alternatives Considered: Any alternative solutions or features you've thought about.

3. Submitting Code Contributions

We welcome code contributions, whether it's a bug fix, new feature, or an improvement. Please follow these steps to contribute:

Fork the Repository

  1. Fork the repo by clicking the "Fork" button on the top right of the repository page.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/infinitel8p/Security-Cam.git
  3. Navigate to your project folder: 
    cd Security-Cam
  4. Make Your Changes
  • Make your changes in the relevant files.
  • Follow the project's code style and conventions.

Push Your Changes

  1. Push your branch to your forked repository: 
    git push origin feature/your-feature-name
  2. Open a Pull Request on the original repository.
  3. In your Pull Request, provide a detailed explanation of what you have done and why.

4. Code Review Process

  • Your Pull Request will be reviewed by one or more maintainers.
  • Be open to feedback and willing to make necessary changes.
  • If there are merge conflicts, resolve them by rebasing your branch on the current main branch and pushing the changes.

5. Documentation

If your change affects any documentation, please update it accordingly. This includes:

  • Updating README files.
  • Adding new documentation files if necessary.
  • Ensuring code examples are accurate.

6. Style Guide

Please adhere to the following style guides:

  • Code Style: Follow the project's existing code style and conventions.
  • Commit Messages: Use clear and descriptive commit messages. Use the imperative mood in the subject line, e.g., "Add feature XYZ."

7. License

By contributing, you agree that your contributions will be licensed under the same license as the project.