Update CONTRIBUTING.md with recent info

pull/2818/head
Yannick Warnier 7 years ago committed by GitHub
parent d9caa5165d
commit 4170484459
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 31
      CONTRIBUTING.md

@ -14,18 +14,14 @@ from the outside world, although we will thoroughly review them before integrati
to make sure they do not introduce security vulnerabilities or degrade the ease
of use of the platform.
The 1.10.x (that you're currently looking at) is a development branch for the
1.10.0 release, that we hope to be releasing around mid-2015. It is a
transitional version that partially uses a series of Symfony 2 modules but relies
1.11.x is a development branch for the 1.11.* releases. The master branch is used for the 2.* releases.
1.10.x and 1.11.x are transitional branches that partially uses a series of Symfony 2 modules but rely
heavily on Composer to manage the dependencies towards common libraries. Version
2.0 has already been worked a lot on, and has served as an inspiration for 1.10.0,
but due to the huge success of the 1.9.x series, we decided to take a transitional
step towards 2.0 to ensure a smooth migration of all our user base to the newer
version (to be released sometime in 2016).
2.0 is based on a deeper integration with Symfony 4.
# Contributing patches or new features
If you'd like to contribute to this project, please read the following document:
If you'd like to contribute to this project, please read the following documents:
* [Coding conventions][1]: The main conventions document
* [PSR-1][2]: PSR-1 are standard conventions rules we use as a base (conversion of old code still in progress)
@ -51,27 +47,30 @@ proceed. You will then need to submit these changes as explained above.
## Database structure changes
If your changes are about structure, you want to follow these steps:
1. Create or modify an entity in src/Chamilo/CoreBundle/Entity/
2. Create a new Migration in src/Chamilo/CoreBundle/Migrations/Schema/V110/
1. Create or modify an entity in src/*something*Bundle/Entity/
2. Create a new Migration in src/CoreBundle/Migrations/Schema/*something*/
This second step is most easily done by copying one of the current migration
files in that directory. For example, if you're doing it on the 14th of July 2015 at noon:
1. Copy Version20150527120703.php to Version20150714120000.php
2. Edit the file and change any "20150527120703" you find to "20150714120000"
files in that directory. For example, if you're doing it on the 14th of July 2019 at noon:
1. Copy Version20190527120703.php to Version20190714120000.php
2. Edit the file and change any "20190527120703" you find to "20190714120000"
3. Check it works by issuing an update command from the command line:
```
php bin/doctrine.php migrations:execute 20150714120000 --up --configuration=app/config/migrations.yml
php bin/console migrations:execute 20190714120000 --up --configuration=app/config/migrations.yml
```
## Database data changes
If you only want to change the *data* in the database, then you don't need to
modify or create an entity, but you will still need to follow these two steps:
1. Modify the main/install/data.sql file (at the end, add a new section before the chamilo_database_version update
1. Modify the main/install/data.sql file (at the end, add a new section before the chamilo_database_version update)
2. Create a new Migration in src/Chamilo/CoreBundle/Migrations/Schema/V110/ (see above section for details)
For configuration settings, check https://github.com/chamilo/chamilo-lms/wiki/Add-a-new-Chamilo-setting
# Testing through Docker
*to be updated*
We are working on an official (production) image of Chamilo LMS for Docker.
In the meantime, you can test development versions following more or less this procedure:
```
@ -108,6 +107,6 @@ line of this command's results (and proceed with the installation on the MySQL s
[1]: https://support.chamilo.org/projects/chamilo-18/wiki/Coding_conventions
[1]: https://github.com/chamilo/chamilo-lms/wiki/Coding-conventions
[2]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md
[3]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md

Loading…
Cancel
Save