diff options
| author | Ben Beltran <ben@nsovocal.com> | 2017-07-03 00:55:32 -0500 |
|---|---|---|
| committer | Ben Beltran <ben@nsovocal.com> | 2017-07-03 00:55:32 -0500 |
| commit | 5e265f9d81bcce30949e88850892ea5dacec7386 (patch) | |
| tree | 056dfe345174027335cc033359dfbe14a8d53250 /CONTRIBUTING.md | |
| parent | 4ae55e0673a61c50f1f7f378f6461d0388f66bd5 (diff) | |
| parent | be33bb82f6276b05a3861df8a7c5138ac320a00b (diff) | |
Merge branch 'release/1.0.0'
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..fe0c941 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,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 |