Skip to content

Latest commit

 

History

History
72 lines (41 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

72 lines (41 loc) · 2.8 KB
Raw

eZ Publish CMS Contributors Guidelines

Thank you for considering contributing to eZ Publish CMS! We appreciate the time and effort you invest in making this project better.

Licensing of code improvements to eZ Publish

eZ Publish is licensed under the GPLv2 or later license, commonly known as the GNU General Public License, version 2 or any later version, grants users the freedom to modify and distribute software. When it comes to code improvements, contributors must ensure that any modifications made to the project are also released under the same GPLv2 or later license. This means that enhancements, bug fixes, or any changes to the codebase must be open-sourced, allowing others to benefit from and build upon these improvements. The "or later" clause allows the project to upgrade to future versions of the GPL, providing flexibility and ensuring alignment with the principles of free software. It's essential for contributors to understand and comply with these licensing requirements to maintain the open nature of the project.

Code of Conduct

Please make sure to review our Code of Conduct before contributing. All contributors are expected to adhere to it.

Getting Started

  1. Fork the repository and clone your fork to your local machine.
git clone https://github.com/your-username/ez-publish.git
  1. Install the project dependencies.
composer install

  1. Set up the development environment.

  2. Create a feature branch for your contribution.

git checkout -b feature/your-feature

Making Changes

  1. Always create a new branch for your work to keep the main branch clean.

  2. Follow the PSR standards and our coding style.

  3. Write clear, concise commit messages following the Conventional Commits specification.

  4. Keep your pull request focused. If you have multiple contributions, submit multiple pull requests.

Submitting Changes

  1. Ensure all tests pass.

  2. Update the documentation if necessary.

  3. Push your changes to your fork.

git push origin feature/your-feature
  1. Submit a pull request to the main repository.

Code Reviews

All contributions will be reviewed before merging. Be open to feedback and be willing to make changes if requested. Code reviews are essential to maintain code quality.

Issues and Discussions

Feel free to open an issue for bug reports, feature requests, or general discussions. Follow the provided templates to provide necessary details.

Licensing

By contributing, you agree that your contributions will be licensed under the GNU General Public License, version 2.0 or later. Make sure that your contributions comply with this license.

Thank you for contributing to eZ Publish CMS!