more/webtrees/CONTRIBUTING.md

1 # How to contribute
3 Thanks for taking the time to contribute!
5 The following is a set of guidelines for contributing to Webtrees. These are mostly guidelines, not…
6 Use your best judgment, and feel free to propose changes to this document in a pull request.
8 ## How to submit a patch or feature
10 If you want to submit a patch or feature, please create a pull request on Github. There are differe…
16 Before submitting a pull request make sure you have [tested the code](#how-to-test)
19 Please read more about [setting up your environment](#how-to-setup-a-development-environment) for d…
21 ## How to start
26 * writing tests to [increase the test coverage](https://coveralls.io/github/fisharebest/webtrees?br…
31 ## How to setup a development environment
33 You will need three tools, in addition to the requirements of a live installation.
35 * `git` - to fetch the latest development code, merge changes, create pull requests, etc.
36 * [`composer`](https://getcomposer.org) - to install PHP dependencies, build releases, and run test…
37 * [`npm`](https://nodejs.org/en/download/package-manager) - to install CSS/JS dependencies and crea…
39 You do not need to understand the details of `composer` and `npm`.  You just need to be able to typ…
41 If you are going to submit your work to the project, you will need a basic understanding of `git`. …
56 If not, you'll need to replace `composer` with `php /path/to/your/copy/of/composer.phar`.
60 … hook" to run checks on your code before you commit them to your local repository.  To do this, re…
64 * After modifying any CSS or JS files, you'll need to rebuild the files in `public/js` and `public/…
69 files in our source tree.  This is usually considered to be bad practice.
71 accustomed to downloading the latest source code and running it without any build step.
87 2. Run `composer install` to update the PHP dependencies.
88 3. Run `npm install` to update the JS and HTML files.
92 ## How to test
106 …ees.net/index.php/en/forum/8-translation) where you can discuss any issues relating to translation.
108 Updates to translations should be made at [translate.webtrees.net](https://translate.webtrees.net).
109 Changes made there will be pushed to webtrees git repository periodically and will be available