]> git.r.bdr.sh - rbdr/forum/blob - CONTRIBUTING.md
Add JSDoc config
[rbdr/forum] / CONTRIBUTING.md
1 # Contributing to Forum
2
3 At this moment Forum is a toy project intended to experiment with ideas
4 for an internet forum based on the past's future.
5
6 ## The objective of Forum
7
8 The main objective is to create a Forum that we would be proud to use in
9 a 90s interpretation of the internet of tomorrow. Any contribution that
10 would push in that direction, or improve the code or processes around it
11 is welcome! :)
12
13 Some ideas so far include:
14
15 * Ephemeral posts
16 * Physical tokens for login
17 * Magic glyphs generated from username
18 * Posts can be categorized by forum or tag, or be completely unlisted
19 * Flagging with option to publish/subscribe to flags
20 * Signatures
21
22 ## How to contribute
23
24 Above All: Be nice, always.
25
26 * Ensure the style checkers show no warnings or errors
27 * Don't break the CI
28 * Make the PRs according to [Git Flow][gitflow]: (features go to
29 develop, hotfixes go to master)
30
31 [gitflow]: https://github.com/nvie/gitflow