Skip to content

Commit a34e069

Browse files
committed
Add contribution description
1 parent 4ce3787 commit a34e069

1 file changed

Lines changed: 54 additions & 1 deletion

File tree

README.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,56 @@
11
# Get started with Ruby
22

3-
Initial course for [Daigaku](https://github.com/daigaku-ruby/daigaku).
3+
This is the initial course for [Daigaku](https://github.com/daigaku-ruby/daigaku), a CLI and text based interface to learn the Ruby programming language.
4+
5+
## Contributing
6+
7+
Daigaku is only helpful for learning Ruby if there are some awesome courses available.
8+
Hence, we like to encourage you to improve the available contents and add chapters and units to this course.
9+
10+
1. Fork it ( https://github.com/daigaku-ruby/Get_started_with_Ruby/fork )
11+
2. Create your feature branch (`git checkout -b my-new-chapter`)
12+
3. Commit your changes (`git commit -am 'Add some chapter'`)
13+
4. Push to the branch (`git push origin my-new-chapter`)
14+
5. Create a new Pull Request
15+
16+
## How to add a chapter or unit
17+
18+
You can add chapters by just adding a new folder which comprises the unit folders.
19+
Each unit folder should contain the `task.md` file and the `solution_spec.rb` file with the tests for the task. Optionally you can add a `solution.rb` file with the reference code. This code will be shown in the Daigaku Screen after the specs passed.
20+
21+
The name of the chapter's folder and the units's folders determine the name that is displayed in the Daigaku Screen.
22+
23+
Naming conventions for a chapter's folder or a unit's folder:
24+
25+
* Start with a number
26+
* Seperate words with underscores (will be substituted with spaces in the Daigaku Screen)
27+
* You can also use dashes within the folder's name (will be preserved in the Daigaku Screen)
28+
29+
If you want to insert a chapter or unit inbetween existing ones you can simply modify the leading numbers of the folder's names. The chapters and units are displayed sorted by the leading number in the Daigaku screen.
30+
31+
Example:
32+
33+
```
34+
└── Get_started_with_Ruby
35+
├── 1_Existing_Chapter_Name
36+
│ ├── 1_Existing_Unit_Name
37+
│ ├── 2_Existing_Unit_Name
38+
│ └── ...
39+
├── 2_New_Chapter-My_way_of_programming
40+
│ ├── 1_New_unit_name
41+
│ │ ├── task.md
42+
│ │ ├── solution_spec.rb
43+
│ │ └── (solution.rb) # optional
44+
│ ├── 2_Another_new_unit_name
45+
│ │ ├── task.md
46+
│ │ ├── solution_spec.rb
47+
│ │ └── (solution.rb) # optional
48+
│ └── ...
49+
├── ...
50+
```
51+
52+
For further instructions on how to create a Daigaku course, the task file, and tests for the task please have a look at the [Daigaku Wiki](https://github.com/daigaku-ruby/daigaku/wiki/How-to-create-a-Daigaku-course).
53+
54+
### License
55+
56+
This course is released under the [MIT License](http://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)