]> git.r.bdr.sh - rbdr/blog/blame - CONTRIBUTING.md
Update version
[rbdr/blog] / CONTRIBUTING.md
CommitLineData
7a5a585e
BB
1# Contributing to Blog
2
3This blog is a personal project, as such it may not be in the best
4condition for anyone to jump in or roll their own. However, if you find
5this useful and would like to send some improvements, please feel free
6to do so. I really appreciate any contribution!
7
8## The objective of blog
9
10The goal of blog is to have an ephemeral static blog that is generated from
11markdown files and their linked assets. It has a max number of posts at
12a time (the default is 3), and every time you publish it removes
13another.
14
15## How to contribute
16
17Above All: Be nice, always.
18
19* Ensure the linter shows no warnings or errors
20* Don't break the CI
21* Make the PRs according to [Git Flow][gitflow]: (features go to
22 develop, hotfixes go to master)
23
24[gitflow]: https://github.com/nvie/gitflow