Contributions are essential for keeping eZ products great. We simply can't access the huge number of platforms and myriad configurations that exists, even if we plan to add more platforms on our CI systems over time it won't cover everything. eZ thus strongly belive in the power of the community to help improve the product in anyway possible for the benefit of the ecosystem.
We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
- Make sure you have a Jira account to report issues.
- Make sure you have a GitHub account to contribute doc, code & tests changes
- Sign the Contributor License Agreement.
- Submit a ticket for your issue, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.
- Mark the Jira ticket with info that change has been submitted for reviewed (Status: Dev/Test/Doc review).
- Include a link to the pull request in the comment.
- Fork the repository on GitHub
- Create a topic branch from where you want to base your work.
- This is usually the master branch, but it can also be branch of another pull request if you intend to contribute to on going work with others.
- To quickly create a topic branch based on master;
git branch fix/master/my_contribution masterthen checkout the new branch withgit checkout fix/master/my_contribution. Please avoid working directly on themasterbranch of your fork, this will cause conflicts. - Naming of the brach should reflect topic and issue number, eg. contribution_example_ezp12345
- Make changes in logical units, follow the eZ coding standar and development guidline.
- Make sure you have added the necessary tests for your changes, preferably you should do the test first proving the bug/missing functionality, then the fix.
- Run all the tests to assure nothing else was accidentally broken, see Readme.md in project repository root for how.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - Make sure your commit messages are in the proper format, and covering what is changed and why.
Fix EZP-12345: Make the example in contributing.md imperative and concrete
Without this patch applied the example commit message in the CONTRIBUTING
document is not a concrete example. This is a problem because the
contributor is left to imagine what the commit message should look like
based on a description rather than an example. This patch fixes the
problem by making the example concrete and imperative.
The first line is a real life imperative statement with a ticket number
from our issue tracker. The body describes the behavior without the patch,
why this is a problem, and how the patch fixes the problem when applied.
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in Jira. In this case, it is appropriate to start the first line of a commit with [DOC] / [APIDOC] / [COMMENT] instead of a ticket, otherwise follow "Making Changes" part.
Add [DOC]: Missing contributing.md part on documentation contributions
There is no example for contributing a documentation commit
to the eZ repositories. This is a problem because the contributor
is left to assume how a commit of this nature may appear.
The first line is a real life imperative statement with '[DOC]:' in
place of what would have been the ticket number in a
non-documentation related commit. The body describes the nature of
the new documentation or comments added.