Skip to main content

How to update Framework

Before proposing/making a change it is necessary to select the relevant repository.

Repositories:

  • Display Temple: if you want to change an util, DCO event or update the FrameAnimation.

  • Display Upload: if you want to create a new upload environment or modify any of the current ones.

  • Display Boilerplate: if you want to modify the initial questions, add parameters, modify a template or create a new one.

  • Display Dev Server: if you want to change a configuration in Webpack, install a plugin and other issues related to dev/build.

Propose a change​

If you want to propose a change, it will be necessary to create a ticket informing in detail what you want to do. Please read the How to create an issue page.

Workflow for make changes​

  1. Fork the repository
  2. Clone your new fork locally
  3. Create a new branch for your changes
  4. Make your changes
    1. npm install node_modules in your local fork
    2. Do your code changes in your fork
    3. Link your local fork with npm link
    4. Test your local fork
      1. By either using npm link @mediamonks/display-dev-server in a test project for for example the display-dev-server
      2. Or for the display-boilerplate, running yo display-boilerplate in a test project and then installing your changes
  5. Submit your pull request
  6. Discuss and review your code
  7. Rebase and tests
  8. “Merge” your branch to the master branch
  9. In the master branch, create a new version (tag) with a message
npm version major/minor/patch -m "this has been updated"
  1. Push your tag to origin
git push origin