aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2017-07-02 21:31:10 -0500
committerBen Beltran <ben@nsovocal.com>2017-07-02 21:31:10 -0500
commit7a5a585ead8c4e967980adc2ab9c7502e47694fd (patch)
tree8f2fd840fc5620e5f4b44c607dd474db5e08d371 /CONTRIBUTING.md
parent4ae55e0673a61c50f1f7f378f6461d0388f66bd5 (diff)
💄📝 Add basic static layout + readme/contributing
Squashed commit of the following: commit f32ca088e9b4d9c6b6edad5271757d886f7177e8 Author: Ben Beltran <ben@nsovocal.com> Date: Sun Jul 2 21:30:20 2017 -0500 Add CHANGELOG commit f5691219950c7546343d42791034cdbba748609b Author: Ben Beltran <ben@nsovocal.com> Date: Sun Jul 2 21:30:00 2017 -0500 Add mac files, and generated files to ignore commit 88ba8c1bed6a6336e1c0ebb5e5d42210a20422a7 Author: Ben Beltran <ben@nsovocal.com> Date: Sun Jul 2 21:28:34 2017 -0500 Add contributing guide commit 160eae6998e2559b6b9e3b21473c930b10278739 Author: Ben Beltran <ben@nsovocal.com> Date: Sun Jul 2 21:24:21 2017 -0500 Add readme commit 36760ff85dbd335afe2c5d9ea9596f81a0ca88a3 Author: Ben Beltran <ben@nsovocal.com> Date: Sun Jul 2 21:11:47 2017 -0500 💄 Add static layout
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md24
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