git.r.bdr.sh - rbdr/blog/blob - CONTRIBUTING.md

   1 # Contributing to Blog
   2
   3 This blog is a personal project, as such it may not be in the best
   4 condition for anyone to jump in or roll their own. However, if you find
   5 this useful and would like to send some improvements, please feel free
   6 to do so. I really appreciate any contribution!
   7
   8 ## The objective of blog
   9
  10 The goal of blog is to have an ephemeral static blog that is generated from
  11 markdown files and their linked assets. It has a max number of posts at
  12 a time (the default is 3), and every time you publish it removes
  13 another.
  14
  15 ## How to contribute
  16
  17 Above 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