Code Version Control¶
The following is a set of conventions about code version control that strives to provide the best way to communicate enough context about every committed code change to fellow developers. These code version control conventions should be used in all Oro projects, except for the projects that adopted some other conventions.
Git and Tools¶
Git is the official version control system used for the majority of the Oro projects. It allows for easy distribution of the source code and keeps each change under version control.
There is a number of tools to manage git repositories, for instance:
- CLI git tools
- PhpStorm Git Integration plugin
- SmartGit, to name a few
Submit a Pull Request¶
The best way to contribute a bug fix or enhancement is to submit a pull request to the Oro repository on GitHub.
Before you submit your pull request consider the following guidelines:
- Search GitHub for an open or closed pull request that relates to your submission. You do not want to duplicate effort.
- Please sign our Contributor License Agreement (CLA) before submitting pull requests. The CLA must be signed for any code or documentation changes to be accepted.
Add a Commit Message¶
The merge commit message contains the message from the author of the changes. This can help understand what the changes were about and the reasoning behind the changes. Therefore, commit messages should include a list of performed actions or changes in the code:
- <action 1>
- <action 2>
- <action 3>