Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 3.62 KB

CONTRIBUTING.md

File metadata and controls

50 lines (39 loc) · 3.62 KB

Contributing to Explyt Spring Plugin

Thank you for your interest in contributing to Explyt Spring Plugin! This document provides guidelines for submitting contributions. By contributing, you agree to abide by our Explyt Source License and follow best practices to keep the project clean, efficient, and secure.

Table of Contents

  1. Code of Conduct
  2. Contribution Requirements
  3. Submitting Contributions
  4. Pull Request Guidelines
  5. Review and Approval Process
  6. License Agreement

1. Code of Conduct

By participating in this project, you agree to adhere to the Code of Conduct. We strive to create a welcoming and respectful environment for everyone.

2. Contribution Requirements

Please note that this repository operates under the Explyt Source License, which prohibits modifications to the Software outside of contributions submitted to this official repository. Contributions should focus on enhancements or improvements that adhere to the plugin’s core purpose without creating derivative works. We encourage contributions that:

  • Enhance usability, performance, or functionality for Spring developers.
  • Improve code readability, documentation, or test coverage.
  • Correct bugs or add features that align with Explyt Spring Plugin's scope.

Important: Contributions that deviate from the project’s purpose or attempt to create a derivative version will be rejected.

3. Submitting Contributions

  1. Fork the repository to create your version of the code.
  2. Create a new branch for your contribution, following naming conventions (e.g., feature/your-feature-name).
  3. Make changes in your local environment, adhering to project guidelines.
  4. Commit your changes with clear messages.
  5. Push your branch to GitHub and prepare for review.

4. Pull Request Guidelines

Ensure that your pull request (PR) meets the following criteria:

  • Link an Issue (if applicable): Reference any related issue in the PR description.
  • Detailed Description: Describe the purpose of the PR, detailing how it improves the plugin's functionality or addresses a specific problem.
  • Code Style: Follow the project’s style and formatting guidelines. Code should be clean, well-documented, and easy to understand.
  • Documentation: Update or create relevant documentation to reflect your changes, including usage examples if new functionality is added.
  • Testing: Include relevant unit tests to verify the integrity of your changes.

5. Review and Approval Process

After submitting a pull request, the Explyt team will:

  • Conduct an Initial Review to ensure your PR aligns with the project’s purpose and license terms.
  • Provide Feedback and Request Changes if adjustments are necessary.
  • Approve and Merge the PR once all requirements are met. Only maintainers have merge permissions.

6. License Agreement

By contributing to this repository, you agree to transfer your contribution rights to Explyt Ltd., granting Explyt a perpetual, irrevocable, worldwide, royalty-free license to use, reproduce, modify, distribute, sublicense, and make your contribution available under the terms of the Explyt Source License. You affirm that you have the right to grant this license to Explyt Ltd.

By following these guidelines, you help maintain the quality and focus of Explyt Spring Plugin while ensuring compliance with the Explyt Source License. Thank you for your contributions!