thereadme/theread.me
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

chore(README): Principles and Formatting

Browse Source
This commit is contained in:
Mahdi Dibaiee 2018-05-12 14:33:56 +04:30
parent 77c0739998
commit 77c9a45d23
1 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,12 +1,30 @@
theread.me
==========
An open-source blog, about programming, life and travel, might as well expand to other stuff, too.
A "free as in freedom" blog you can write on without any fuss. It's simply that.
Want to write on the blog? open a pull-request.
Principles
----------
Authors can be anonymous, or you can write your name and a link as author.
1. There are no hard-limits on the topics, most topics are welcome, unless there is some very explicit content (extremism, porn), but that's to be decided about democratically.
2. Original content only, no promotional content or ads. You must be the one who actually wrote the piece.
3. You may or may not write anonymously, you are not required to mention your name as the author if you don't want to.
4. In order to keep the blog tidy, we try to keep a standard format. This [format](#formatting) is explained below.
5. This is a collaborative and community-driven project, so suggestions and criticisms are welcome.
* Think we can improve the blog in some way? Let's discuss it in [issues](issues) section!
* Want to help us improve the blog? Take a look at open issues with [help-wanted](issues/filter:help-wanted) tag
There is no clear rule of what gets accepted and what gets rejected, if you get rejected, there will most probably
be an explanation of why, if it's not something very off-topic, and if value is found in the content, you will most likely
be accepted. We don't want to dictate anything, we just want to keep things tidy.
Formatting
------
* Use italics to highlight titles: book titles, post titles, paper titles, etc.
* Use bold to highlight attention-deserving parts, your post should not have many bold words in a short pieces as it distracts the user by de-focusing their attention.
* Use blockquotes for directly quoted text if it's long enough
* Use quotes to highlight: directly quoted parts, puns (if you want to), to emphasize that a word itself is meant, not it's meaning (example: I painted "circle" on the board)
* Link when links can help gather additional information. Readers should not feel the need to manually search a piece of text if we can link to the most-relevant link for a subject. As a general rule of thumb: Link to Wikipedia when mentioning a special name (person, book, project, etc.) if the subject does not have a it's own homepage on the internet.
* Use images only when they enhance the content, not indiscriminately, just so your post looks like _media_.
* Use the [figure] element to add a caption to images, or if a caption is not necessary, use a meaningful `alt` attribute for sake of accessibility.
Write
-----------
Once you have read [Principles](#Principles) and [Formatting](#Formatting), write and send a pull-request.