Skip to content

Commit 2a0af05

Browse files
authored
Merge pull request #1 from FilipeRamalho/master
Created a publishing workflow, now includes a linting workflow and was also linted.
2 parents fcacf32 + 01ec544 commit 2a0af05

File tree

6 files changed

+64
-16
lines changed

6 files changed

+64
-16
lines changed

.mdlintrc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"default": true,
3+
"MD026": {
4+
"punctuation": ".,;:!"
5+
},
6+
"MD013": {
7+
"line_length": 300
8+
}
9+
}

.travis.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
before_install:
2+
- npm i -g Laboratoria/mdlint
3+
4+
script:
5+
- npm run lint
6+

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# How to contribute
2+
3+
You write you own language chapter using the layout on chapters/language.md
4+
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.

README.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,10 @@
11
# Community-Programming-Book
22

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

5-
Language 1
6-
Introduction
7-
8-
History
9-
- Year of creation
10-
- Person(s) who created it. Organization?
11-
- Purpose of creation
12-
13-
What problems it solves? What it does well.
14-
- Relate back to why it was created (purpose).
15-
- Basically a reason why you would use this language
16-
- Include example code to demonstrate
5+
The Devrant community gathered together to create a book on
6+
multiple programming languages. We want you to understand why
7+
this languages have come to exist and why they for example use
8+
either brackets or indenting.
179

18-
Where you should use it. (Recommend use)
19-
20-
Shortcomings of the language. (Not recommended for)
10+
> Any fool can write code that a computer can understand. Good programmers write code that humans can understand. - Martin Fowler

chapters/language.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# [Language]
2+
3+
## Introduction
4+
5+
## History
6+
7+
- Year of creation
8+
- Person(s) who created it. Organization?
9+
- Purpose of creation
10+
11+
## 'What problems does it solve ?
12+
13+
- What it does well.
14+
- Relate back to why it was created (purpose).
15+
- Basically a reason why you would use this language
16+
- Include example code to demonstrate
17+
18+
## Where you should use it
19+
20+
- Recommended use
21+
22+
## Shortcomings of the language
23+
24+
- Not recommended for
25+
26+
## Opinions on language
27+
28+
## Technical information of language
29+
30+
## Where to continue to read on

package.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"name": "Community-Programming-Book",
3+
"scripts": {
4+
"lint": "mdlint ."
5+
},
6+
"devDependencies": {
7+
"mdlint": "Laboratoria/mdlint"
8+
}
9+
}

0 commit comments

Comments
 (0)