CONTRIBUTING.md 5.39 KB
Newer Older
lostinlight's avatar
lostinlight committed
1 2 3

# CONTRIBUTING

4
Don't hesitate to send a merge request.
lostinlight's avatar
lostinlight committed
5

6
### [Submitting software](#submitting-software)
lostinlight's avatar
lostinlight committed
7

8 9 10 11 12
**Software** here is "a) project that can be installed on a server and self-hosted b) project that may be interesting to the general public, independent of their technical knowledge".

If your project targets mainly *developers*, tech-savvy users or is a helper (reference library, bot, relay, etc), please, submit it to **TOOLS** page (see below).

Software submitted to **ALL APPS** website page **must be**:
13 14 15 16 17
* Fully open source (please, consider showcasing your closed source apps on https://the-federation.info)
* Supporting or planning to support one of the following protocols: OStatus, diaspora, Zot, ActivityPub (please, consider showcasing your apps federating via other protocols on https://the-federation.info)

Fork this repository. Add your project data to `./source/_data/miscellaneous.json` file.

18
A project **must have** *title, source, protocols (1 string, comma separated), license, categories* and appropriate protocol classes marked as `true`.
19

20
Please, choose no more than **2 categories** (array of strings) for the software. The ones it was initially designed for.
21

22
#### Software categories (WIP, may change in the future)
23 24 25 26 27 28 29 30
* `SN-ma` (social network: macroblogging)
* `SN-mi` (social network: microblogging)
* `Blog-Pub` (blog and publishing software)
* `Media` (media sharing: images, audio, etc)
* `Links` (link sharing)
* `Ev-Meet` (events, meetups, calendars)
* `Files` (file hosting software)
* `Econ` (economic activities)
31
* `DataForge` (dataset / corpora exchange)
32 33
* `Reviews` (networks whose main purpose is reviewing stuff)
* `Games` (gaming servers and apps)
34 35 36 37 38 39 40

A project may have a logo / image (45x45px), placed in `./source/img/misc` folder.

### [Submitting tools](#submitting-tools)
Fork this repository. Add your project data to `./source/_data/tools.json` file.

#### Tools categories (WIP, may change in the future)
41 42 43 44
* `Libs` (frameworks, libraries, reference implementations in particular code language)
* `Specs` (Fediverse protocol specifications)
* `Tools` (for developer and geeky tools, like pastebins, git systems, pads, etc)
* `Utils` (daemons, bots, resharers, and other such services for Fediverse)
lostinlight's avatar
lostinlight committed
45
* `Relays` (Fediverse relays)
46 47 48 49
* `Bridges` (bridging other stuff to fediverse networks)
* `Tests` (any kind of test tools)
* `Plugins` (CMS plugins, apps to be installed inside other systems connecting to Fediverse)
* `Other` (everything that doesn't quite fit into the above categories)
50

51
### [Submitting news](#submitting-news)
lostinlight's avatar
lostinlight committed
52

53 54
Please, read our [guidelines](./GUIDELINES.md) for guest authors.

lostinlight's avatar
lostinlight committed
55 56
**Data located in**: `/source/_posts` folder

57
**[Chronicles](https://fediverse.party/en/chronicles)** page aggregates latest news about federating software, interviews with developers, first-person narratives, Fediverse related research and analysis.
lostinlight's avatar
lostinlight committed
58

59 60
Posts are available via [RSS](https://fediverse.party/atom.xml) subscription.
`Preview` is rendered on Chronicles page (limited ammount), text after metadata is shown in RSS (unlimited) and on post's page (see [Tags](https://fediverse.party/tags) ).
lostinlight's avatar
lostinlight committed
61 62 63 64 65 66

Every post **must have** the following __metadata__:

```
layout: "post"
title: "some title"
67
date: 2222-01-25
lostinlight's avatar
lostinlight committed
68 69 70 71 72 73
tags:
    - pleroma
preview:
  "short gist..."
url: "https://pleroma.social/link-to-news-source"
lang: en
74
authors: [{"name": "John Snow", "url": "https://ggg.social", "network": "socialhome"}]
lostinlight's avatar
lostinlight committed
75 76 77
```

`Tags`
78 79 80
A tag is either "fediverse" for general articles or the title of a particular Fediverse project.

A post may have one of these tags: actorscafe, anfora, commonspub, diaspora, distbin, dokieli, dolphin, epicyon, fediblog, fediverse, forgefed, friendica, funkwhale, gancio, gnusocial, groundpolis, guppe, honk, hubzilla, kanzaki, kibou, kroeg, lemmy, mastodon, microblogpub, misskey, mobilizon, moontree, nautilus, peertube, pixelfed, pleroma, plume, prismo, p3k, reel2bits, rustodon, social (for NextCloud Social), smithereen, socialhome, writefreely, zap.
lostinlight's avatar
lostinlight committed
81 82 83

`Preview`
Limit 150 characters - for "regular" and "wanted" posts, limit 350 characters - for "featured" post.
84
Please, stay within the limits in preview, otherwise it gets truncated half-sentence and will be posted that way on the Chronicles front page. Not good.
lostinlight's avatar
lostinlight committed
85 86 87 88 89 90 91 92 93 94

__Optional metadata__:

```
wanted: true
featured: true
banner: "pic.jpg"
```

`Wanted`
95
Add this metadata to a post that you wish to show in the upper visible part of the Chronicles page. Calls for contribution, calls for donations, calls for help should be posted with this metadata.
lostinlight's avatar
lostinlight committed
96 97

`Featured`
98
Add this metadata to a guest post, long-form article, to show the post in a prominent part of the Chronicles page.
lostinlight's avatar
lostinlight committed
99

100
`Wanted` and `featured` can't be mixed and are temporary. This metadata must be removed from an older post when creating a new "featured" or "wanted" post.
lostinlight's avatar
lostinlight committed
101

lostinlight's avatar
lostinlight committed
102
`Banner`
103
Required for "featured" posts only, an image wide enough to be used as a fullscreen background (~1920px), should be placed in `/source/_posts/exact-post-file-name` folder. Any other images used in this article may be placed there as well. See [example](https://git.feneas.org/feneas/fediverse/tree/master/source/_posts/fediverse-saves-from-pickup-artists-and-7-more-reasons-to-join).
lostinlight's avatar
lostinlight committed
104 105

`Authors`
106
Required. Add an array of object(s): name you wish to be shown as the author, and one website link (preferably link to your Fediverse profile). If it's the link to your account on Fediverse, specify network name - lower case, without spaces.
lostinlight's avatar
lostinlight committed
107

108
**Thanks!**