diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..6dde4f74 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing to Stack Builders Tutorials + +First off, thanks for taking the time to contribute! :tada::+1: + +The following is a set of guidelines for contributing to Stack Builders Tutorials, which are +hosted in the [Stack Builders Organization](https://github.com/stackbuilders) on +GitHub. +These are mostly just guidelines, not rules, use your best judgment and feel free +to propose changes to this document in a pull request. + +## Contributing Guide + +1. [Fork it](https://github.com/stackbuilders/tutorials/fork) +1. Create your tutorial branch (`git checkout -b my-new-tutorial`) +1. Add your tutorial changes following the [tutorial guide](#tutorial-creation-guide) +1. Commit your changes (`git commit -am 'Add some tutorial'`) +1. Push to the branch (`git push origin my-new-tutorial`) +1. Create a new Pull Request + +## Tutorial Creation Guide + +1. Create a new directory for your tutorial under `tutorials//` +1. Inside `tutorials//` create a directory +named `code` and place your tutorial's code in there +1. Add a `tutorial.md` file under `tutorials//` +with the steps required for accomplishing your tutorial. Use +[this tutorial](../tutorials/haskell/csv-encoding-decoding/tutorial.md) as a guide. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..e69de29b diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..e69de29b diff --git a/README.md b/README.md index ee93f3f1..0aad410a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,27 @@ -# tutorials +# Stack Builders Tutorials + +[![CircleCI](https://circleci.com/gh/stackbuilders/tutorials.svg?style=shield)](https://circleci.com/gh/stackbuilders/tutorials) + +At Stack Builders, we consider it our mission not only to develop robust and reliable applications for clients, but to help the industry as a whole by lowering the barrier to entry for technology that we consider important. We hope that you enjoy, and find useful, our tutorials. If you have suggestions for additional tutorials, please feel free to open an issue or PR. + +## Contributing + + +We welcome any help, so if you have good knowledge of Haskell just fork and submit a pull request with your tutorial. Be sure to read our [contribution guidelines](.github/CONTRIBUTING.md) first. ## License -- These tutorials are licensed under a Creative Commons +* The content of these tutorials is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International license - ([CC BY-NC-SA 4.0](http://creativecommons.org/licenses/by-nc-sa/4.0/)). + ([CC BY-NC-SA 4.0](http://creativecommons.org/licenses/by-nc-sa/4.0/)) +* The code in these tutorials is licensed under the [MIT License](https://opensource.org/licenses/MIT). + +*** + +

+ +
+ Lovingly encouraged by Stack Builders +

diff --git a/images/sb-logo.png b/images/sb-logo.png new file mode 100644 index 00000000..48632b61 Binary files /dev/null and b/images/sb-logo.png differ