CONTRIBUTING.md 1.05 KB
Newer Older
1
# How To Contribute
2 3

## Workflow
4

5 6 7 8 9 10 11 12
* Fork Git Repo https://git.feneas.org/diasporg/Poduptime
* Pull Git
* Create a topic branch to work from
* Commit and push your branch up
* Create a Merge Request to the develop branch

## Guidelines

13 14 15
* 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
16
* Update the [Wiki] with API changes
17 18
* Write your tests and validate them before you do your MR

19 20 21 22 23
## Coding Style

* PHP follows [PSR-2]
* CSS follows [CSSLint]
* JS follows [ESLint]
24

25 26 27
[`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
28 29 30 31
[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/