Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

71 lines (50 loc) · 2.8 KB

Contributing to Sentinel

Welcome to Sentinel! We appreciate your interest in contributing to our open-source project. Your contributions help make our project better and more inclusive. Before you get started, please take a moment to review our contribution guidelines.

Types of Contributions We Welcome

  • Bug Fixes: Help us identify and fix issues in the project.
  • New Features: Contribute new features and enhancements to improve the project.
  • Documentation: Improve project documentation, README files, or provide examples.
  • Bug Reports: Report any issues, errors, or bugs you encounter.
  • Feedback: Share your feedback, ideas, or suggestions for improvement.
  • Testing: Help us test the project, identify edge cases, and ensure its reliability.
  • Code Reviews: Review pull requests, provide feedback, and help maintain code quality.

Getting Started

To contribute to Sentinel, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone your forked repository to your local machine.

  3. Create a new branch for your contribution:

      git checkout -b feature/your-feature-name

  4. Make your changes, additions, or fixes.

  5. Ensure your code adheres to our coding standards and conventions.

  6. Commit your changes with descriptive commit messages.

  7. Push your changes to your forked repository:

      git push origin feature/your-feature-name

  8. Open a pull request (PR) from your forked repository to this main repository.

Pull Request Guidelines

When creating a pull request, please follow these guidelines:

  • Provide a clear and concise description of your changes.
  • Reference any relevant issues or related pull requests.
  • Ensure your code is well-documented and includes inline comments where necessary.
  • Test your changes thoroughly and provide evidence of successful testing.
  • Be responsive to any feedback or comments on your pull request.

Code of Conduct

We enforce a Code of Conduct to ensure a welcoming and inclusive environment for all contributors. Please review our Code of Conduct to understand our community standards.

Our Commitment

Our project maintainers are committed to responding promptly to issues, pull requests, and inquiries from contributors. We appreciate your time and effort in making this project better.

Thank you for contributing to Sentinel!

Attribution

We would like to acknowledge and thank all our contributors for their valuable contributions to this project. Your dedication and support are greatly appreciated.

This CONTRIBUTING.md file is based on best practices and guidelines for open-source contribution. Please note that contribution rules may be subject to change over time to better suit the needs of the project.

Back to Top