Skip to content

Latest commit

 

History

History
95 lines (57 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

95 lines (57 loc) · 3.7 KB
Raw

Contributing to the SecureFace

Thank you for your interest in contributing to the SecureFace Access Control System! We welcome contributions from the community to help improve and enhance the project. Before you get started, please take a moment to review this guide to understand our contribution process.

Code of Conduct

Please note that this project follows a Code of Conduct. By participating in this project, you agree to abide by its terms.

How to Contribute

Registering on CONTRIHUB

Before you begin contributing to this project, please make sure to register yourself on CONTRIHUB. This platform is used to assign and track issues related to this project.

Note that you must get an issue assigned to you on CONTRIHUB before you begin working on it.

Reporting Issues

If you encounter bugs, issues, or have suggestions for improvements, please open a GitHub issue. When reporting an issue, please provide as much detail as possible, including:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue (if applicable).
  • Expected behavior and actual behavior.
  • Any error messages or screenshots (if applicable).

Suggesting Enhancements

We value your ideas and suggestions for enhancing the project. If you have a feature request or enhancement proposal, please open a GitHub issue with the "enhancement" label. Describe the proposed feature or enhancement in detail, and explain why it would be beneficial.

Contributing Code

We encourage contributions to the codebase that improve existing functionality or add new features. To contribute code, please follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/sanskaromar/secureface.git

  3. Create a new branch for your work:

    git checkout -b feature-or-bugfix-name

  4. Make your changes and commit them with clear, descriptive commit messages:

    git add .
git commit -m "Add feature: your feature name" # Use a descriptive message

  5. Push your changes to your forked repository:

    git push origin feature-or-bugfix-name

  6. Open a Pull Request (PR) from your branch to the main project repository on GitHub.

  7. Your PR will be reviewed by project maintainers. Make any necessary changes based on feedback.

  8. Once your PR is approved, it will be merged into the main branch, and your contributions will be part of the project.

Running Tests

Before submitting a code contribution, it's essential to ensure that your changes pass the existing tests and, if applicable, add new tests to cover your changes. You can run the tests using the following command:

python -m unittest discover tests

Please make sure your code does not break any existing tests and maintains code coverage.

Documentation

Contributions to project documentation are also highly valuable. If you find any inconsistencies, errors, or areas that need improvement in the documentation, please open a PR to address them.

Code Style

We follow a consistent code style to maintain readability and code quality. Please adhere to the following guidelines when contributing:

  • Use PEP 8-compliant formatting.
  • Write clear and concise comments and docstrings.
  • Use meaningful variable and function names.
  • Ensure your code is well-documented.

License

By contributing to the SecureFace Access Control System, you agree that your contributions will be licensed under the MIT License.

Thank you for helping improve the SecureFace Access Control System!