README

Remember! This vendor library is currently use in many projects. Please ensure that your changes are backward compatible.

Rules of modifying this vendor library

1. If you add new modification, you must ensure backward compatibility.
2. Adding new version to Git repository, you must send new tag
3. If your modification is:
   • hotfix - increment last number e.g. 1.0.0 -> 1.0.1
   • feature - increment second number e.g. 1.0.0 -> 1.1.0
   • new version - a lot of modification which breaks BC, increment first number: 1.0.0 -> 2.0.0

Instalation of vendor in local environment

If you want to copy repository to your local storage, you have 2 ways:

• Each project should contain utils/prepare_vendors script, which download vendor repositories from Git and link to project. Run it.
• If you want to copy only one vendor, create vendor directory and clone Git repository directly from there. Remember, if you want to use this vendor in your project, you have to manually create symlink to directory /src/Awaresoft.

Modify vendor library and update origin version

• Always modify this library directly from your project. Vendor should be symlinked to /src/Awaresoft directory in your project.
• If you install this library before by Composer, you must remove this package from /vendor directory. After this operation got to: /vendor/composer/autoload_psr4.php file, find connection to this library and remove it from there.
• After that you can refresh your cache by: app/console ca:cl command.
• To commit new changes in library, use:

  git add .
  git commit -m "[message]"
  

• Add new tag, corresponding to naming convention of tags: Check if tag is available, before add new one:

git tag [x.x.x]

git push
git push --tags