# Documentation for developpers

This package has for purpose to manage the main SeaCMS package and allowing updates of the main packages via `composer`.

## TODO

 - [ ] set contact addresses into `CODE_OF_CONDUCT.md` files
 - [ ] update `composer.json` file as described below
 - [ ] create a `SUPPORT.md` file at the root
 - [ ] update content of `.github/CONTRIBUTING.md`
 - [ ] check content of `.github/PULL_REQUEST_TEMPLATE.md`

## `composer.json` file

This files needs to be updated.
Currently, it uses `"minimum-stability": "dev",` to allow usage of `alpha` revisions of packages.

### TODO

add these fields :

```json
    "name": "TODO To be defined",
    "description": "TODO to complete",
    "homepage": "TODO To set",
    "authors": [
        {
            "name": "xxx",
            "email": "TODO complete",
            "homepage": "TODO complete",
            "role": "Developer"
        },
        {
            "name": "xxxx",
            "email": "TODO complete",
            "homepage": "TODO complete",
            "role": "Developer"
        },
    ],
    "support": {
        "email": "support@example.org",
        "issues": "url",
        "source": "url",
        "docs": "url",
        "chat": "url",
        "rss": "url",
    },
    "funding": [
        {
            "type": "patreon",
            "url": "https://www.patreon.com/phpdoctrine"
        },
        {
            "type": "tidelift",
            "url": "https://tidelift.com/subscription/pkg/packagist-doctrine_doctrine-bundle"
        },
        {
            "type": "other",
            "url": "https://www.doctrine-project.org/sponsorship.html"
        }
    ]
```

## `.github` folder

It was choosen to name the folder as `.github` to allow compatibility for forks on GitHUb even if the folder could be named `.gitea`.