Currently we have some license issues. We are working on it.

Commit c0f90add authored by noplanman's avatar noplanman
Browse files

Merge branch 'contrib' into 'develop'

Add base CONTRIBUTING.md

See merge request !203
parents 09481a05 7ebc0c2f
......@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog] and this project adheres to [Semantic
- Added bootstrapping to simplify initialisation of config and database
- Config syntax has changed to array style (#155)
- Added `pghost` config to set database port
- Added `CONTRIBUTING.md`
### Changed
- Introduce proper changelog format (#189)
- Moved DB migration scripts into `db` folder
......
# How To Contribute
## Workflow
* 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
* 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
## Coding Style
* PHP follows [PSR-2]
* CSS follows [CSSLint]
* JS follows [ESLint]
[`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/
......@@ -2,16 +2,16 @@
## New install
When setting up a new install, import [`db/tables.sql`][tables.sql] and do not perform any migrations!
When setting up a new install, import [`db/tables.sql`] and do not perform any migrations!
## Migrating
If you are upgrading your existing installation, execute the necessary migrations scripts found in [`db/migrations`][migrations].
If you are upgrading your existing installation, execute the necessary migrations scripts found in [`db/migrations`].
## API v1
To support the original API v1 you should import [`db/pods_apiv1.sql`][pods_apiv1.sql] into your DB as often as you want your API updated.
To support the original API v1 you should import [`db/pods_apiv1.sql`] into your DB as often as you want your API updated.
[tables.sql] https://git.feneas.org/diasporg/Poduptime/blob/master/db/tables.sql
[migrations] https://git.feneas.org/diasporg/Poduptime/tree/master/db/migrations
[pods_apiv1.sql] https://git.feneas.org/diasporg/Poduptime/blob/master/db/pods_apiv1.sql
[`db/tables.sql`]: https://git.feneas.org/diasporg/Poduptime/blob/master/db/tables.sql
[`db/migrations`]: https://git.feneas.org/diasporg/Poduptime/tree/master/db/migrations
[`db/pods_apiv1.sql`]: https://git.feneas.org/diasporg/Poduptime/blob/master/db/pods_apiv1.sql
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment