[github/shaarli/Shaarli.git] / doc / md / Development-guidelines.md

## Development guidelines

Please have a look at the following pages:

- [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md)
- [Static analysis](Static-analysis) - patches should try to stick to the 
[PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially:
    - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard
    - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide
- [Unit tests](Unit-tests)
- Javascript linting - Shaarli uses [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript). 
Run `make eslint` to check JS style.
- [GnuPG signature](GnuPG-signature) for tags/releases
Commit	Line	Data
53ed6d7d	1	## Development guidelines
	2
	3	Please have a look at the following pages:
43ad7c8e	4
53ed6d7d	5	- [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md)
d7eb06bd A	6	- [Static analysis](Static-analysis) - patches should try to stick to the
d7eb06bd A	7	[PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially:
53ed6d7d	8	- [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard
53ed6d7d	9	- [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide
d7eb06bd A	10	- [Unit tests](Unit-tests)
	11	- Javascript linting - Shaarli uses [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).
	12	Run `make eslint` to check JS style.
	13	- [GnuPG signature](GnuPG-signature) for tags/releases