From 9c1fa59d4bd13616886d3db9c04f384047eda2c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Armando=20L=C3=BCscher?= Date: Tue, 7 Aug 2018 01:45:40 +0200 Subject: [PATCH] Update contributing guide. --- CONTRIBUTING.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b052b70..b8950b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ -# How To Contibute +# How To Contribute ## Workflow + * Fork Git Repo https://git.feneas.org/diasporg/Poduptime * Pull Git * Create a topic branch to work from @@ -9,14 +10,22 @@ ## Guidelines -* Note your changes in Changelog.md following https://keepachangelog.com -* Note your db migrations in db/migrations/README.md -* Update README.md with needed changes -* Update the Wiki with API changes https://git.feneas.org/diasporg/Poduptime/wikis/home +* Note your changes in [CHANGELOG.md] following https://keepachangelog.com +* Create any necessary DB migration script in [db/migrations] and note them in the changelog. +* Update [README.md] with needed changes +* Update the [Wiki] with API changes * Write your tests and validate them before you do your MR -## Style +## Coding Style + +* PHP follows [PSR-2] +* CSS follows [CSSLint] +* JS follows [ESLint] -* PHP follows PSR-2 https://www.php-fig.org/psr/psr-2/ -* CSS follows CSSLint https://github.com/CSSLint/csslint -* JS follows ESLint https://eslint.org/docs/rules/ +[README.md]: https://git.feneas.org/diasporg/Poduptime/blob/master/README.md +[CHANGELOG.md]: https://git.feneas.org/diasporg/Poduptime/blob/master/CHANGELOG.md +[db/migrations]: https://git.feneas.org/diasporg/Poduptime/tree/master/db/migrations +[Wiki]: https://git.feneas.org/diasporg/Poduptime/wikis/home +[PSR-2]: https://www.php-fig.org/psr/psr-2/ +[CSSLint]: https://github.com/CSSLint/csslint +[ESLint]: https://eslint.org/docs/rules/ -- GitLab