Skip to content
This repository has been archived by the owner on May 26, 2021. It is now read-only.

Editing templates & static files for beginners

Marc-AntoineA edited this page Jul 6, 2019 · 1 revision

Contributing through Github

If you want to edit emails templates or static files and you don't know about programming, just follow these guidelines:

  1. Create your own Github account
  2. Fork this repository (button in the upper right corner of the screen)
  3. Open your fork on your private Github profile
  4. Select the branch develop
  5. Do the edits directly trough the Github website, don't forget to add a commit message to explain your modification
  6. Once you are satisfied of your modifications, click on New pull request, explain on it your changes - it would be added to the next version

The files that you can edit

  • static texts for the applicant website: applicant_frontend/src/static.json
  • email templates: backend/emails

Warnings:

  • In the .json file:
    • The structure should stay exactly the same (same labels)
    • Every text should be in only one line (no breakline allowed in the json format)
    • If you want to format text, use html format
    • For templating, use the same syntax as used {{ something }}.
  • In the .pug files :
    • The syntax should respect the .pug syntax defined here pugjs. You can use this tool to test the result pughtml.com
    • The subject.pug is for the subject of the email (use ${something} for templating)
    • The html.pug is for the content of the email (use #{something} for templating)