Skip to content

Instantly share code, notes, and snippets.

@jryannel
Created June 18, 2018 16:38
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jryannel/d4d2eafadd6dd3c5d66d97f25ea64b6b to your computer and use it in GitHub Desktop.
Save jryannel/d4d2eafadd6dd3c5d66d97f25ea64b6b to your computer and use it in GitHub Desktop.
# Contributing
:+1::tada: First, thanks for taking the time to contribute! :tada::+1:
The following is a set of guidelines to contribute to the QmlBook, which is hosted at (https://github.com/qmlbook/qmlbook/) on GitHub.
## Licensing
You provide us the contributions under the [Attribution-NonCommercial-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/) license for text and the [BSD](http://opensource.org/licenses/BSD-3-Clause) license for code. We keep the rights to print a book based on the provided content. We can not ensure that everyone will be correctly named, but we will do our best. This is just so that you understand what you are about todo :-).
Still interested? Cool. Welcome!
## Issues
Each chapter of the qmlbook (http://qmlbook.org) has several 'issue' reporting links. Please use these when you find a spelling error or another issue in the text. This will help us to identify the section later. The issue link will let you create or view the issues of this particular chapter.
The issues can be found at (https://github.com/qmlbook/qmlbook/issues)
## Patch Contribution
We use the standard github pull requests for merging your fork of the book back to this one. You can find more information at (https://help.github.com/articles/using-pull-requests/).
## Chapter Contribution
If you feel adventurous enough to contribute a full chapter your name will then be placed in the chapter for your reference. For this create a new chapter folder (e.g. ch99) and write your content using the [Sphinx](http://sphinx-doc.org) markup. We will then place the chapter into the chapter queue and when it's ready we will sort it into the table of contents.
## Translations
So you speak something else then English? Great! Feel free to translate the book into your language. For this, clone the repository and then later create a pull request that we can sort this in. Before you start you should contact us on gitter to make sure there is no overlap.
Note: The infrastructure is not yet there, but soon we should be ready for translations.
// JRyannel, JThelin
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment