Skip to content

Latest commit

 

History

History
82 lines (65 loc) · 5.86 KB

CONTRIBUTING.md

File metadata and controls

82 lines (65 loc) · 5.86 KB
Raw

Contributing to Pimcore

As an open source project we love to work together with our community to improve and develop our products. It's also important for us to make clear that we're not working for you or your company, but we enjoy to work together to solve issues or improve the product.

Contributing Pull Requests

We gladly accept community pull requests. This is the preferred way to contribute to Pimcore. There are a few necessary steps before we can accept a pull request:

  • Fork us!
  • Select the right branch. main(11.x) for features and improvements or latest maintenance branch for bug fixes (11.1)
  • Code! Follow the coding standards defined here and here
  • Send a pull request from your fork’s branch to our repo branch.
  • Sign the CLA - see also below.

Bug Reports

Please provide a fix for the bug as a pull request (PR) whenever possible!
If you've created a pull request, it's not necessary anymore to create an issue for the bug.

  • Only file an issue if you're not able to fix the bug and provide the patch as a pull request.
  • Please keep in mind that the Pimcore team will only work on system critical and security bugs.
  • Open an issue here on GitHub.
  • Report security issues only by using this form.
  • Please be patient as not all items will be tested immediately - remember, pimcore is open source and free of charge.
  • Occasionally we'll close issues if they appear stale or are too vague - please don't take this personally! Please feel free to re-open issues we've closed if there's something we've missed and they still need to be addressed.

Package Types

Please note that we categorize our packages into two types, as indicated in the 'About' section of each GitHub repository. This categorization helps us prioritize and focus our resources effectively:

  • Core Packages: These are packages under active development by the Pimcore team, and of course we also welcome and incorporate contributions from the community.
  • Community Packages: These packages are not currently being actively developed by the Pimcore team. However, we remain committed to their basic maintenance, as well as to reviewing and accepting pull requests, especially for critical bug fixes, and will release new versions as needed.

Inactive Issue Closing Policy

Pimcore uses a bot that closes abandoned issues after a period of inactivity. If an issue was not labeled as "Priority" or "Backlog" by us, this means that we're not going to work on that anytime soon. In case of a bug report, you can create a pull request fixing the issue instead, which will be then reviewed as soon as possible. If you're interested in contributing a feature, please contact us first, before creating a pull request, we'll then decide whether we'd accept it or not.

Contributor License Agreement

The following terms are used throughout this agreement:

  • You - the person or legal entity including its affiliates asked to accept this agreement. An affiliate is any entity that controls or is controlled by the legal entity, or is under common control with it.

  • Project - is an umbrella term that refers to any and all Pimcore projects.

  • Contribution - any type of work that is submitted to a Project, including any modifications or additions to existing work.

  • Submitted - conveyed to a Project via a pull request, commit, issue, or any form of electronic, written, or verbal communication with Pimcore, contributors or maintainers.

1. Grant of Copyright License.

Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and to Pimcore a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your contributions and such derivative works. Except for this license, You reserve all rights, title, and interest in your contributions.

2. Grant of Patent License.

Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and to Pimcore a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer your contributions, where such license applies only to those patent claims licensable by you that are necessarily infringed by your contribution or by combination of your contribution with the project to which this contribution was submitted.

If any entity institutes patent litigation - including cross-claim or counterclaim in a lawsuit - against You alleging that your contribution or any project it was submitted to constitutes or is responsible for direct or contributory patent infringement, then any patent licenses granted to that entity under this agreement shall terminate as of the date such litigation is filed.

3. Source of Contribution.

Your contribution is either your original creation, based upon previous work that, to the best of your knowledge, is covered under an appropriate open source license and you have the right under that license to submit that work with modifications, whether created in whole or in part by you, or you have clearly identified the source of the contribution and any license or other restriction (like related patents, trademarks, and license agreements) of which you are personally aware.