learn-generate 1.0.15 → 1.0.16

Sign up to get free protection for your applications and to get access to all the features.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/learn-generate.gemspec +1 -1
  3. data/lib/learn_generate/helpers/dot-learn-helper.rb +1 -1
  4. data/lib/learn_generate/ios_lab.rb +0 -6
  5. data/lib/learn_generate/template_maker.rb +11 -10
  6. data/lib/learn_generate/version.rb +1 -1
  7. data/lib/templates/activerecord/CONTRIBUTING.md +37 -0
  8. data/lib/templates/activerecord/LICENSE.md +7 -0
  9. data/lib/templates/activerecord/README.md +17 -5
  10. data/lib/templates/command-line/CONTRIBUTING.md +37 -0
  11. data/lib/templates/command-line/LICENSE.md +7 -0
  12. data/lib/templates/command-line/README.md +17 -5
  13. data/lib/templates/front-end/CONTRIBUTING.md +37 -0
  14. data/lib/templates/front-end/LICENSE.md +7 -0
  15. data/lib/templates/front-end/README.md +17 -5
  16. data/lib/templates/fundamental-ruby/CONTRIBUTING.md +37 -0
  17. data/lib/templates/fundamental-ruby/LICENSE.md +7 -0
  18. data/lib/templates/fundamental-ruby/README.md +17 -5
  19. data/lib/templates/ios/CONTRIBUTING.md +37 -0
  20. data/lib/templates/ios/LICENSE.md +7 -0
  21. data/lib/templates/js/CONTRIBUTING.md +37 -0
  22. data/lib/templates/js/LICENSE.md +7 -0
  23. data/lib/templates/js/README.md +17 -5
  24. data/lib/templates/kids/CONTRIBUTING.md +37 -0
  25. data/lib/templates/kids/LICENSE.md +7 -0
  26. data/lib/templates/kids/README.md +4 -6
  27. data/lib/templates/python/.python-version +1 -0
  28. data/lib/templates/python/CONTRIBUTING.md +37 -0
  29. data/lib/templates/python/LICENSE.md +7 -0
  30. data/lib/templates/python/README.md +16 -0
  31. data/lib/templates/python/sample.py +4 -0
  32. data/lib/templates/python/sample_test.py +13 -0
  33. data/lib/templates/rack/CONTRIBUTING.md +37 -0
  34. data/lib/templates/rack/LICENSE.md +7 -0
  35. data/lib/templates/rack/README.md +16 -5
  36. data/lib/templates/rake/CONTRIBUTING.md +37 -0
  37. data/lib/templates/rake/LICENSE.md +7 -0
  38. data/lib/templates/rake/README.md +16 -5
  39. data/lib/templates/readme/CONTRIBUTING.md +37 -0
  40. data/lib/templates/readme/LICENSE.md +7 -0
  41. data/lib/templates/readme/README.md +1 -8
  42. data/lib/templates/sinatra-classic-db/CONTRIBUTING.md +37 -0
  43. data/lib/templates/sinatra-classic-db/README.md +16 -5
  44. data/lib/templates/sinatra-classic/CONTRIBUTING.md +37 -0
  45. data/lib/templates/sinatra-classic/LICENSE.md +7 -0
  46. data/lib/templates/sinatra-classic/README.md +16 -5
  47. data/lib/templates/sinatra-mvc/CONTRIBUTING.md +37 -0
  48. data/lib/templates/sinatra-mvc/LICENSE.md +7 -0
  49. data/lib/templates/sinatra-mvc/README.md +16 -5
  50. data/lib/templates/sql/CONTRIBUTING.md +37 -0
  51. data/lib/templates/sql/LICENSE.md +7 -0
  52. data/lib/templates/sql/README.md +16 -5
  53. metadata +36 -4
  54. data/lib/templates/kids/.DS_Store +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 7083b7453caca61040642960737e2a8b637cbb24
4
- data.tar.gz: 9c82b7183789720f12525ab3a8c753f476d4e5c6
3
+ metadata.gz: b5159d53ccd47f1e1d5e9c55dffcf8cbc1de0562
4
+ data.tar.gz: 8b6d5926aec0cd943e85f6d3d44816e7ee047597
5
5
  SHA512:
6
- metadata.gz: 4d2a8331112f9777581e41bbf545dd7b18030b142956f2276ec4dcecf38f9cb28782868034a62d6b0a70fdbdc209d14e1bc6052bffbcbff9e2e73ab33392a0a6
7
- data.tar.gz: 6d2d1f5c3ef4eb181990e9f759db90681ad173bbca133fcd309fb7b62567c0c42feb929f7001dca64cb539a37ce8f3fd40231f1e98fd1a97b5bb474cad5658f3
6
+ metadata.gz: 5856aefdd9b6745598c6fbfd2b597b256b607c17ca237487a3c348c6ff3cfa4c8f7488231f9aeff524b241d14baad2143bfc06ebdb4c8432a41c77e34340addc
7
+ data.tar.gz: e690a31a6a13978e07823ee862216bcfcbeb28028bd9526182347aca2ebf8c1c2785375245efab7a0bcde9ff10ad064d17a134ea9d669c2c9dffa56a0f0e3ff7
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
10
10
  spec.email = ["learn@flatironschool.com"]
11
11
  spec.summary = %q{A lab generator}
12
12
  spec.description = %q{Generates labs for Learn.co based on a set of lab templates}
13
- spec.homepage = "https://learn.co"
13
+ spec.homepage = "https://github.com/learn-co/learn-generate"
14
14
  spec.license = "MIT"
15
15
 
16
16
  spec.files = `git ls-files -z`.split("\x0")
@@ -3,7 +3,7 @@ module LearnGenerate
3
3
  module DotLearnHelper
4
4
  def build_dot_learn
5
5
  File.open('.learn', 'a') do |f|
6
- f.write("tags:\n - tag1\nlanguages:\n - language1\nresources: 0")
6
+ f.write("tags:\n - tag_1\n - tag_2\nlanguages:\n - language_1\n - language_1\nresources: 0")
7
7
  end
8
8
  end
9
9
  end
@@ -1,9 +1,3 @@
1
- # TODO:
2
- # DONE 1. check for liftoff -> brew ls --versions liftoff (if not installed, instruct user to run brew tap thoughtbot/formulae && brew install liftoff)
3
- # DONE 2. if there is a .liftoffrc || .liftoff file/dir, backup
4
- # DONE 3. copy either bundled template or in templates_dir
5
- # DONE 4. run liftoff
6
- # DONE 5. restore .liftoffrc && .liftoff (if necessary)
7
1
  module LearnGenerate
8
2
  class IosLab
9
3
  attr_reader :lab_name, :liftoff_installed, :liftoffrc_exists,
@@ -39,6 +39,7 @@ module LearnGenerate
39
39
  js_helper if template_type == "js"
40
40
  fe_helper if template_type == "front-end"
41
41
  kids_helper if template_type == "kids"
42
+ add_link_to_learn
42
43
  end
43
44
  else
44
45
  create_ios_lab
@@ -68,17 +69,11 @@ module LearnGenerate
68
69
  end
69
70
 
70
71
  def edit_readme
71
- if template_type == 'readme'
72
- readme_contents = File.read('README.md')
73
- readme_contents.sub!('## Objectives', "# #{formatted_name}\n\n## Objectives")
72
+ readme_contents = File.read('README.md')
73
+ readme_contents.sub!('## Objectives', "# #{formatted_name}\n\n## Objectives")
74
74
 
75
- File.open('README.md', 'w+') do |f|
76
- f.write(readme_contents)
77
- end
78
- else
79
- File.open('README.md', 'a') do |f|
80
- f << "\n# #{formatted_name}"
81
- end
75
+ File.open('README.md', 'w+') do |f|
76
+ f.write(readme_contents)
82
77
  end
83
78
  end
84
79
 
@@ -129,5 +124,11 @@ module LearnGenerate
129
124
  end
130
125
  end
131
126
  end
127
+
128
+ def add_link_to_learn
129
+ File.open('README.md', 'a') do |f|
130
+ f << "\n<a href='https://learn.co/lessons/#{lab_name}' data-visibility='hidden'>View this lesson on Learn.co</a>\n"
131
+ end
132
+ end
132
133
  end
133
134
  end
@@ -1,3 +1,3 @@
1
1
  module LearnGenerate
2
- VERSION = '1.0.15'
2
+ VERSION = '1.0.16'
3
3
  end
@@ -0,0 +1,37 @@
1
+ # Contributing to Learn.co Curriculum
2
+
3
+ We're really exited that you're about to contribute to the [open curriculum](https://learn.co/content-license) on [Learn.co](https://learn.co). If this is your first time contributing, please continue reading to learn how to make the most meaningful and useful impact possible.
4
+
5
+ ## Raising an Issue to Encourage a Contribution
6
+
7
+ If you notice a problem with the curriculum that you believe needs improvement
8
+ but you're unable to make the change yourself, you should raise a Github issue
9
+ containing a clear description of the problem. Include relevant snippets of
10
+ the content and/or screenshots if applicable. Curriculum owners regularly review
11
+ issue lists and your issue will be prioritized and addressed as appropriate.
12
+
13
+ ## Submitting a Pull Request to Suggest an Improvement
14
+
15
+ If you see an opportunity for improvement and can make the change yourself go
16
+ ahead and use a typical git workflow to make it happen:
17
+
18
+ * Fork this curriculum repository
19
+ * Make the change on your fork, with descriptive commits in the standard format
20
+ * Open a Pull Request against this repo
21
+
22
+ A curriculum owner will review your change and approve or comment on it in due
23
+ course.
24
+
25
+ # Why Contribute?
26
+
27
+ Curriculum on Learn is publicly and freely available under Learn's
28
+ [Educational Content License](https://learn.co/content-license). By
29
+ embracing an open-source contribution model, our goal is for the curriculum
30
+ on Learn to become, in time, the best educational content the world has
31
+ ever seen.
32
+
33
+ We need help from the community of Learners to maintain and improve the
34
+ educational content. Everything from fixing typos, to correcting
35
+ out-dated information, to improving exposition, to adding better examples,
36
+ to fixing tests—all contributions to making the curriculum more effective are
37
+ welcome.
@@ -0,0 +1,7 @@
1
+ #Learn.co Educational Content License
2
+
3
+ Copyright (c) 2015 Flatiron School, Inc
4
+
5
+ The Flatiron School, Inc. owns this Educational Content. However, the Flatiron School supports the development and availability of educational materials in the public domain. Therefore, the Flatiron School grants Users of the Flatiron Educational Content set forth in this repository certain rights to reuse, build upon and share such Educational Content subject to the terms of the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). You must read carefully the terms and conditions contained in the Educational Content License as such terms govern access to and use of the Educational Content.
6
+
7
+ Flatiron School is willing to allow you access to and use of the Educational Content only on the condition that you accept all of the terms and conditions contained in the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). By accessing and/or using the Educational Content, you are agreeing to all of the terms and conditions contained in the Educational Content License. If you do not agree to any or all of the terms of the Educational Content License, you are prohibited from accessing, reviewing or using in any way the Educational Content.
@@ -1,5 +1,17 @@
1
- ---
2
- tags:
3
- languages:
4
- resources:
5
- ---
1
+
2
+ ## Objectives
3
+
4
+ 1. Objective 1
5
+ 2. Objective 2
6
+
7
+ ## Instructions
8
+
9
+ Create make the tests pass Heroku lab. API Nokogiri guest speaker belongs_to RESTful binder.ply. Url Rails slack it to me. Asset pipeline Feelings Friday puts "woof" API open source.
10
+
11
+ Destroy now we can teach dogs to do anything link drop tables lab The Gucci bundle install. Associations def iterate infobesity Twitter. Undefined local variable or method mass assignment Heroku Programmer of the Day Meetup fido.bark. Internet create. Ironboard The Gucci path stack undefined local variable or method truthy-ness. Sqlite3 scooter blog posts DRY The Gucci cat. Truthy-ness bundle.
12
+
13
+ ### Part 1: Do Some Stuff
14
+
15
+ ## Resources
16
+
17
+ * [Stack Exchange](http://www.stackexchange.com) - [Some Question on Stack Exchange](http://www.stackexchange.com/questions/123)
@@ -0,0 +1,37 @@
1
+ # Contributing to Learn.co Curriculum
2
+
3
+ We're really exited that you're about to contribute to the [open curriculum](https://learn.co/content-license) on [Learn.co](https://learn.co). If this is your first time contributing, please continue reading to learn how to make the most meaningful and useful impact possible.
4
+
5
+ ## Raising an Issue to Encourage a Contribution
6
+
7
+ If you notice a problem with the curriculum that you believe needs improvement
8
+ but you're unable to make the change yourself, you should raise a Github issue
9
+ containing a clear description of the problem. Include relevant snippets of
10
+ the content and/or screenshots if applicable. Curriculum owners regularly review
11
+ issue lists and your issue will be prioritized and addressed as appropriate.
12
+
13
+ ## Submitting a Pull Request to Suggest an Improvement
14
+
15
+ If you see an opportunity for improvement and can make the change yourself go
16
+ ahead and use a typical git workflow to make it happen:
17
+
18
+ * Fork this curriculum repository
19
+ * Make the change on your fork, with descriptive commits in the standard format
20
+ * Open a Pull Request against this repo
21
+
22
+ A curriculum owner will review your change and approve or comment on it in due
23
+ course.
24
+
25
+ # Why Contribute?
26
+
27
+ Curriculum on Learn is publicly and freely available under Learn's
28
+ [Educational Content License](https://learn.co/content-license). By
29
+ embracing an open-source contribution model, our goal is for the curriculum
30
+ on Learn to become, in time, the best educational content the world has
31
+ ever seen.
32
+
33
+ We need help from the community of Learners to maintain and improve the
34
+ educational content. Everything from fixing typos, to correcting
35
+ out-dated information, to improving exposition, to adding better examples,
36
+ to fixing tests—all contributions to making the curriculum more effective are
37
+ welcome.
@@ -0,0 +1,7 @@
1
+ #Learn.co Educational Content License
2
+
3
+ Copyright (c) 2015 Flatiron School, Inc
4
+
5
+ The Flatiron School, Inc. owns this Educational Content. However, the Flatiron School supports the development and availability of educational materials in the public domain. Therefore, the Flatiron School grants Users of the Flatiron Educational Content set forth in this repository certain rights to reuse, build upon and share such Educational Content subject to the terms of the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). You must read carefully the terms and conditions contained in the Educational Content License as such terms govern access to and use of the Educational Content.
6
+
7
+ Flatiron School is willing to allow you access to and use of the Educational Content only on the condition that you accept all of the terms and conditions contained in the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). By accessing and/or using the Educational Content, you are agreeing to all of the terms and conditions contained in the Educational Content License. If you do not agree to any or all of the terms of the Educational Content License, you are prohibited from accessing, reviewing or using in any way the Educational Content.
@@ -1,5 +1,17 @@
1
- ---
2
- tags:
3
- languages:
4
- resources:
5
- ---
1
+
2
+ ## Objectives
3
+
4
+ 1. Objective 1
5
+ 2. Objective 2
6
+
7
+ ## Instructions
8
+
9
+ Create make the tests pass Heroku lab. API Nokogiri guest speaker belongs_to RESTful binder.ply. Url Rails slack it to me. Asset pipeline Feelings Friday puts "woof" API open source.
10
+
11
+ Destroy now we can teach dogs to do anything link drop tables lab The Gucci bundle install. Associations def iterate infobesity Twitter. Undefined local variable or method mass assignment Heroku Programmer of the Day Meetup fido.bark. Internet create. Ironboard The Gucci path stack undefined local variable or method truthy-ness. Sqlite3 scooter blog posts DRY The Gucci cat. Truthy-ness bundle.
12
+
13
+ ### Part 1: Do Some Stuff
14
+
15
+ ## Resources
16
+
17
+ * [Stack Exchange](http://www.stackexchange.com) - [Some Question on Stack Exchange](http://www.stackexchange.com/questions/123)
@@ -0,0 +1,37 @@
1
+ # Contributing to Learn.co Curriculum
2
+
3
+ We're really exited that you're about to contribute to the [open curriculum](https://learn.co/content-license) on [Learn.co](https://learn.co). If this is your first time contributing, please continue reading to learn how to make the most meaningful and useful impact possible.
4
+
5
+ ## Raising an Issue to Encourage a Contribution
6
+
7
+ If you notice a problem with the curriculum that you believe needs improvement
8
+ but you're unable to make the change yourself, you should raise a Github issue
9
+ containing a clear description of the problem. Include relevant snippets of
10
+ the content and/or screenshots if applicable. Curriculum owners regularly review
11
+ issue lists and your issue will be prioritized and addressed as appropriate.
12
+
13
+ ## Submitting a Pull Request to Suggest an Improvement
14
+
15
+ If you see an opportunity for improvement and can make the change yourself go
16
+ ahead and use a typical git workflow to make it happen:
17
+
18
+ * Fork this curriculum repository
19
+ * Make the change on your fork, with descriptive commits in the standard format
20
+ * Open a Pull Request against this repo
21
+
22
+ A curriculum owner will review your change and approve or comment on it in due
23
+ course.
24
+
25
+ # Why Contribute?
26
+
27
+ Curriculum on Learn is publicly and freely available under Learn's
28
+ [Educational Content License](https://learn.co/content-license). By
29
+ embracing an open-source contribution model, our goal is for the curriculum
30
+ on Learn to become, in time, the best educational content the world has
31
+ ever seen.
32
+
33
+ We need help from the community of Learners to maintain and improve the
34
+ educational content. Everything from fixing typos, to correcting
35
+ out-dated information, to improving exposition, to adding better examples,
36
+ to fixing tests—all contributions to making the curriculum more effective are
37
+ welcome.
@@ -0,0 +1,7 @@
1
+ #Learn.co Educational Content License
2
+
3
+ Copyright (c) 2015 Flatiron School, Inc
4
+
5
+ The Flatiron School, Inc. owns this Educational Content. However, the Flatiron School supports the development and availability of educational materials in the public domain. Therefore, the Flatiron School grants Users of the Flatiron Educational Content set forth in this repository certain rights to reuse, build upon and share such Educational Content subject to the terms of the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). You must read carefully the terms and conditions contained in the Educational Content License as such terms govern access to and use of the Educational Content.
6
+
7
+ Flatiron School is willing to allow you access to and use of the Educational Content only on the condition that you accept all of the terms and conditions contained in the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). By accessing and/or using the Educational Content, you are agreeing to all of the terms and conditions contained in the Educational Content License. If you do not agree to any or all of the terms of the Educational Content License, you are prohibited from accessing, reviewing or using in any way the Educational Content.
@@ -1,5 +1,17 @@
1
- ---
2
- languages: html, css
3
- tags:
4
- resources:
5
- ---
1
+
2
+ ## Objectives
3
+
4
+ 1. Objective 1
5
+ 2. Objective 2
6
+
7
+ ## Instructions
8
+
9
+ Create make the tests pass Heroku lab. API Nokogiri guest speaker belongs_to RESTful binder.ply. Url Rails slack it to me. Asset pipeline Feelings Friday puts "woof" API open source.
10
+
11
+ Destroy now we can teach dogs to do anything link drop tables lab The Gucci bundle install. Associations def iterate infobesity Twitter. Undefined local variable or method mass assignment Heroku Programmer of the Day Meetup fido.bark. Internet create. Ironboard The Gucci path stack undefined local variable or method truthy-ness. Sqlite3 scooter blog posts DRY The Gucci cat. Truthy-ness bundle.
12
+
13
+ ### Part 1: Do Some Stuff
14
+
15
+ ## Resources
16
+
17
+ * [Stack Exchange](http://www.stackexchange.com) - [Some Question on Stack Exchange](http://www.stackexchange.com/questions/123)
@@ -0,0 +1,37 @@
1
+ # Contributing to Learn.co Curriculum
2
+
3
+ We're really exited that you're about to contribute to the [open curriculum](https://learn.co/content-license) on [Learn.co](https://learn.co). If this is your first time contributing, please continue reading to learn how to make the most meaningful and useful impact possible.
4
+
5
+ ## Raising an Issue to Encourage a Contribution
6
+
7
+ If you notice a problem with the curriculum that you believe needs improvement
8
+ but you're unable to make the change yourself, you should raise a Github issue
9
+ containing a clear description of the problem. Include relevant snippets of
10
+ the content and/or screenshots if applicable. Curriculum owners regularly review
11
+ issue lists and your issue will be prioritized and addressed as appropriate.
12
+
13
+ ## Submitting a Pull Request to Suggest an Improvement
14
+
15
+ If you see an opportunity for improvement and can make the change yourself go
16
+ ahead and use a typical git workflow to make it happen:
17
+
18
+ * Fork this curriculum repository
19
+ * Make the change on your fork, with descriptive commits in the standard format
20
+ * Open a Pull Request against this repo
21
+
22
+ A curriculum owner will review your change and approve or comment on it in due
23
+ course.
24
+
25
+ # Why Contribute?
26
+
27
+ Curriculum on Learn is publicly and freely available under Learn's
28
+ [Educational Content License](https://learn.co/content-license). By
29
+ embracing an open-source contribution model, our goal is for the curriculum
30
+ on Learn to become, in time, the best educational content the world has
31
+ ever seen.
32
+
33
+ We need help from the community of Learners to maintain and improve the
34
+ educational content. Everything from fixing typos, to correcting
35
+ out-dated information, to improving exposition, to adding better examples,
36
+ to fixing tests—all contributions to making the curriculum more effective are
37
+ welcome.
@@ -0,0 +1,7 @@
1
+ #Learn.co Educational Content License
2
+
3
+ Copyright (c) 2015 Flatiron School, Inc
4
+
5
+ The Flatiron School, Inc. owns this Educational Content. However, the Flatiron School supports the development and availability of educational materials in the public domain. Therefore, the Flatiron School grants Users of the Flatiron Educational Content set forth in this repository certain rights to reuse, build upon and share such Educational Content subject to the terms of the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). You must read carefully the terms and conditions contained in the Educational Content License as such terms govern access to and use of the Educational Content.
6
+
7
+ Flatiron School is willing to allow you access to and use of the Educational Content only on the condition that you accept all of the terms and conditions contained in the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). By accessing and/or using the Educational Content, you are agreeing to all of the terms and conditions contained in the Educational Content License. If you do not agree to any or all of the terms of the Educational Content License, you are prohibited from accessing, reviewing or using in any way the Educational Content.
@@ -1,5 +1,17 @@
1
- ---
2
- tags:
3
- languages:
4
- resources:
5
- ---
1
+
2
+ ## Objectives
3
+
4
+ 1. Objective 1
5
+ 2. Objective 2
6
+
7
+ ## Instructions
8
+
9
+ Create make the tests pass Heroku lab. API Nokogiri guest speaker belongs_to RESTful binder.ply. Url Rails slack it to me. Asset pipeline Feelings Friday puts "woof" API open source.
10
+
11
+ Destroy now we can teach dogs to do anything link drop tables lab The Gucci bundle install. Associations def iterate infobesity Twitter. Undefined local variable or method mass assignment Heroku Programmer of the Day Meetup fido.bark. Internet create. Ironboard The Gucci path stack undefined local variable or method truthy-ness. Sqlite3 scooter blog posts DRY The Gucci cat. Truthy-ness bundle.
12
+
13
+ ### Part 1: Do Some Stuff
14
+
15
+ ## Resources
16
+
17
+ * [Stack Exchange](http://www.stackexchange.com) - [Some Question on Stack Exchange](http://www.stackexchange.com/questions/123)
@@ -0,0 +1,37 @@
1
+ # Contributing to Learn.co Curriculum
2
+
3
+ We're really exited that you're about to contribute to the [open curriculum](https://learn.co/content-license) on [Learn.co](https://learn.co). If this is your first time contributing, please continue reading to learn how to make the most meaningful and useful impact possible.
4
+
5
+ ## Raising an Issue to Encourage a Contribution
6
+
7
+ If you notice a problem with the curriculum that you believe needs improvement
8
+ but you're unable to make the change yourself, you should raise a Github issue
9
+ containing a clear description of the problem. Include relevant snippets of
10
+ the content and/or screenshots if applicable. Curriculum owners regularly review
11
+ issue lists and your issue will be prioritized and addressed as appropriate.
12
+
13
+ ## Submitting a Pull Request to Suggest an Improvement
14
+
15
+ If you see an opportunity for improvement and can make the change yourself go
16
+ ahead and use a typical git workflow to make it happen:
17
+
18
+ * Fork this curriculum repository
19
+ * Make the change on your fork, with descriptive commits in the standard format
20
+ * Open a Pull Request against this repo
21
+
22
+ A curriculum owner will review your change and approve or comment on it in due
23
+ course.
24
+
25
+ # Why Contribute?
26
+
27
+ Curriculum on Learn is publicly and freely available under Learn's
28
+ [Educational Content License](https://learn.co/content-license). By
29
+ embracing an open-source contribution model, our goal is for the curriculum
30
+ on Learn to become, in time, the best educational content the world has
31
+ ever seen.
32
+
33
+ We need help from the community of Learners to maintain and improve the
34
+ educational content. Everything from fixing typos, to correcting
35
+ out-dated information, to improving exposition, to adding better examples,
36
+ to fixing tests—all contributions to making the curriculum more effective are
37
+ welcome.
@@ -0,0 +1,7 @@
1
+ #Learn.co Educational Content License
2
+
3
+ Copyright (c) 2015 Flatiron School, Inc
4
+
5
+ The Flatiron School, Inc. owns this Educational Content. However, the Flatiron School supports the development and availability of educational materials in the public domain. Therefore, the Flatiron School grants Users of the Flatiron Educational Content set forth in this repository certain rights to reuse, build upon and share such Educational Content subject to the terms of the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). You must read carefully the terms and conditions contained in the Educational Content License as such terms govern access to and use of the Educational Content.
6
+
7
+ Flatiron School is willing to allow you access to and use of the Educational Content only on the condition that you accept all of the terms and conditions contained in the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). By accessing and/or using the Educational Content, you are agreeing to all of the terms and conditions contained in the Educational Content License. If you do not agree to any or all of the terms of the Educational Content License, you are prohibited from accessing, reviewing or using in any way the Educational Content.
@@ -0,0 +1,37 @@
1
+ # Contributing to Learn.co Curriculum
2
+
3
+ We're really exited that you're about to contribute to the [open curriculum](https://learn.co/content-license) on [Learn.co](https://learn.co). If this is your first time contributing, please continue reading to learn how to make the most meaningful and useful impact possible.
4
+
5
+ ## Raising an Issue to Encourage a Contribution
6
+
7
+ If you notice a problem with the curriculum that you believe needs improvement
8
+ but you're unable to make the change yourself, you should raise a Github issue
9
+ containing a clear description of the problem. Include relevant snippets of
10
+ the content and/or screenshots if applicable. Curriculum owners regularly review
11
+ issue lists and your issue will be prioritized and addressed as appropriate.
12
+
13
+ ## Submitting a Pull Request to Suggest an Improvement
14
+
15
+ If you see an opportunity for improvement and can make the change yourself go
16
+ ahead and use a typical git workflow to make it happen:
17
+
18
+ * Fork this curriculum repository
19
+ * Make the change on your fork, with descriptive commits in the standard format
20
+ * Open a Pull Request against this repo
21
+
22
+ A curriculum owner will review your change and approve or comment on it in due
23
+ course.
24
+
25
+ # Why Contribute?
26
+
27
+ Curriculum on Learn is publicly and freely available under Learn's
28
+ [Educational Content License](https://learn.co/content-license). By
29
+ embracing an open-source contribution model, our goal is for the curriculum
30
+ on Learn to become, in time, the best educational content the world has
31
+ ever seen.
32
+
33
+ We need help from the community of Learners to maintain and improve the
34
+ educational content. Everything from fixing typos, to correcting
35
+ out-dated information, to improving exposition, to adding better examples,
36
+ to fixing tests—all contributions to making the curriculum more effective are
37
+ welcome.