Skip to content

Making a publishing workflow #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 24, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .mdlintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"default": true,
"MD026": {
"punctuation": ".,;:!"
},
"MD013": {
"line_length": 300
}
}
6 changes: 6 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
before_install:
- npm i -g Laboratoria/mdlint

script:
- npm run lint

4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# How to contribute

You write you own language chapter using the layout on chapters/language.md
The subtitles are one suggestion on how to structure the chapter, you only have to write all information that would also come together by the template structure.
22 changes: 6 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,10 @@
# Community-Programming-Book

<b>Format per language:</b>
[![Build Status](https://travis-ci.org/devRant-Squad/Community-Programming-Book.svg?branch=master)](https://travis-ci.org/devRant-Squad/Community-Programming-Book)

Language 1
Introduction

History
- Year of creation
- Person(s) who created it. Organization?
- Purpose of creation

What problems it solves? What it does well.
- Relate back to why it was created (purpose).
- Basically a reason why you would use this language
- Include example code to demonstrate
The Devrant community gathered together to create a book on
multiple programming languages. We want you to understand why
this languages have come to exist and why they for example use
either brackets or indenting.

Where you should use it. (Recommend use)

Shortcomings of the language. (Not recommended for)
> Any fool can write code that a computer can understand. Good programmers write code that humans can understand. - Martin Fowler
30 changes: 30 additions & 0 deletions chapters/language.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# [Language]

## Introduction

## History

- Year of creation
- Person(s) who created it. Organization?
- Purpose of creation

## 'What problems does it solve ?

- What it does well.
- Relate back to why it was created (purpose).
- Basically a reason why you would use this language
- Include example code to demonstrate

## Where you should use it

- Recommended use

## Shortcomings of the language

- Not recommended for

## Opinions on language

## Technical information of language

## Where to continue to read on
9 changes: 9 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "Community-Programming-Book",
"scripts": {
"lint": "mdlint ."
},
"devDependencies": {
"mdlint": "Laboratoria/mdlint"
}
}