-
Notifications
You must be signed in to change notification settings - Fork 21
Add contribution guidelines #9
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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/<language>/` | ||
| 1. Inside `tutorials/<language>/<your-tutorial-dir>` create a directory | ||
| named `code` and place your tutorial's code in there | ||
| 1. Add a `tutorial.md` file under `tutorials/<language>/<your-tutorial-dir>` | ||
| with the steps required for accomplishing your tutorial. Use | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I will try to rephrase this one.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. which part specifically?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. hate this note format/workflow, I constantly get lost |
||
| [this tutorial](../tutorials/haskell/csv-encoding-decoding/tutorial.md) as a guide. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,27 @@ | ||
| # tutorials | ||
| # Stack Builders Tutorials | ||
|
|
||
| [](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 | ||
|
|
||
| <!-- | ||
| [](http://issuestats.com/github/stackbuilders/tutorials) [](http://issuestats.com/github/stackbuilders/tutorials) | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @nebtrx What is http://issuestats.com/ about? I can't even see the site (application error). Will it give us something other than number of open and closed issues?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yup it measures the contribution and the activity on the repo, those are not working now because it's private. It's kind of common practice to gain adepts. I thought it would be nice, lemme know if that makes sense to you
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It sounds good, but the site in general seems to be broken, not just for this repository.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yup is down right now, that's weird, first time I saw that happens 🤔
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If it's not up before merging this, let's just remove the badges.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm gonna comment those and let it ready for when we go out public |
||
| --> | ||
| 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). | ||
|
|
||
| *** | ||
|
|
||
| <p align="center"> | ||
| <img src="images/sb-logo.png" /> | ||
| </br> | ||
| <b>Lovingly encouraged by <a href="http://stackbuilders.com">Stack Builders</a></b> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. logo missing
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @jpvillaisaza where can we get one of the logos?. Just to be sure we're in the same page @seuros, you meant a logo in the footer?.Although we can put everywhere. |
||
| </p> | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would rephrase this as "These are mostly guidelines, rather than rules, so "