Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

47 lines (34 loc) · 1.68 KB
Raw

Contributing

The project is open and any contribution is welcome!

Backend part (PHP)

To keep the code clean, we use php-cs-fixer, before commit launch this on each edited files:

php /usr/local/bin/php-cs-fixer fix /path/to/editedFile.php -v

You can handle all edited files with this single line:

cd /var/www/money; for file in $(git diff-index --name-only HEAD); do php /usr/local/bin/php-cs-fixer fix "$file" -v; done

Frontend part (VueJS)

In order to contribute to the VueJS frontend:

  1. Install prerequisite:
  • Node.js
  • npm npm install npm@latest -g
  1. Access the frontend folder in a shell cd /var/www/money/money-front-vue
  2. Build the project npm install and wait for the downloads
  3. Start the node server npm run dev
  4. Edit the code!

Translations

Application was translated into the following languages:

  • english,
  • french.

If you are interested in adding a new translation or updating an existing one, take a look at these two folders:

  • back-end API, you will need ICU for bulding ResourceBundle (Debian and Ubuntu have icu-devtools package wich allow you to produce .res file with genrb money/server/lang/*.txt command),
  • front-end.

Or you can just provide translations in an issue and we will add it.

A little how-to for Github

  1. Fork it
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes (with a detailled message): git commit -am 'Add an awesome feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request