aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: fe0c9411a58b5c8f71117089527d95b6c40f8ace (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Contributing to Blog

This blog is a personal project, as such it may not be in the best
condition for anyone to jump in or roll their own. However, if you find
this useful and would like to send some improvements, please feel free
to do so. I really appreciate any contribution!

## The objective of blog

The goal of blog is to have an ephemeral static blog that is generated from
markdown files and their linked assets. It has a max number of posts at
a time (the default is 3), and every time you publish it removes
another.

## How to contribute

Above All: Be nice, always.

* Ensure the linter shows no warnings or errors
* Don't break the CI
* Make the PRs according to [Git Flow][gitflow]: (features go to
  develop, hotfixes go to master)

[gitflow]: https://github.com/nvie/gitflow