Rules

Jump to bottom

Jan Stránský edited this page Aug 23, 2018 · 2 revisions

Git workflow

Commits

[GC-1] Split changes to separate commits by project.

Commit messages

[GC-2] Use prefix (projectname). For example: (ethereum) Update logos. When you updating webids, then prefix will be (webids) and so on.

Pull Requests (PR)

TODO

Directory structure

TODO

Database

Common properties

`webids`

[DCP-1] Custom services is linkable via webid with custom/ prefix. These webids dont have any definitions, and value is URL.]
```
custom/forum: https://forum.project.org    # valid
custom/anything: https://anything.org      # valid too
```

Project

`project.id`

[DPR-1] Don't fill. Its automatically generated from project directory name.

`project.name`

[DPR-2] Must be official name, usually with capital letter.

`project.web`

[DPR-3] Only official web page(s).

`project.team`

[DPR-5] Only humans, please.

`project.team.name`

[DPR-6] Nicknames or fictional names are allowed, when real name is not known.

`project.team.roles`

[DPR-7] Roles is separated by comma (,). For example: Co-founder, CEO.

`project.whitepapers`

[DPR-8] Only whitepapers created direcly by project. One document = one whitepapers item.

`project.whitepapers.url`

[DPR-9] Only direct link to specific document/PDF.

`project.tags`

TODO

`project.partners`

TODO

`project.history`

TODO

`project.resources`

TODO

Network

`network.id`

TODO

`network.name`

TODO

WebIDs definition (webids.yaml)

Same service with more types of webids

[DWI-1] Separate webids item for each purpose. Main purpose is without suffix, other purposes is written with /<purpose> suffix. For example: reddit webid points to Reddit thread and reddit/user points to Reddit user profile.