Skip to content

Latest commit

 

History

History
35 lines (17 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

35 lines (17 loc) · 2.07 KB

Contributing

👍🎉 First, thanks for taking the time to contribute! 🎉👍

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 Attribution-NonCommercial-ShareAlike 4.0 International license for text and BSD license for code. We keep us the rights to print a book based on the provided content. We can not ensure that everyone will then be correctly named, but we will do the best. This is just that you understand what you are about todo:-).

Still interested? Cool. Welcome!

Issues

Each chapter on 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 foud 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

You might feel adventures and are willing to contribute a full chapter. Your name will then be placed on the chapter for your reference. For this crate a new chaprer folder (e.g. ch99) and write your content using Sphinx 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