Contributing

Please read our contribution guidelines before creating an issue or pull request.

Please note that the issue tracker on this repository is for issues with the contents of the documentation, not support queries. Please post support queries in the forums.

When creating an issue, please:

  • Explain the issue as clearly as possible
  • Include a link to the page(s) to which your issue relates
  • Use Markdown to format your issue, particularly for blocks of code

Creating a pull request:

  • If your contribution regards typos and spelling mistakes, feel free to fix these, and they'll be merged if they accord with our in-house style guide. Otherwise, always open an issue first. This will allow us to determine whether or not the change should take place. Explain your issue, and we will discuss it with you. If we agree the change is necessary, we will mark it as 'TODO'. Then we will either fix it when we get a chance, or allow a member of the community to supply the change with a pull request.
  • Note that this documentation is intended to be a short and concise set of helpful resources aimed at the majority of users. We will only feature our recommended distribution, Raspbian, in detail; in order to keep the documentation manageable, we will not accept additions covering alternative distributions.

Find a short tutorial on making changes using GitHub here.

Please be aware we are not able to deal with all issues and pull requests immediately, so please have patience.

Derivatives

The licence must remain in all derivatives of this work.

Licence

Creative Commons Licence

Raspberry Pi Documentation by the Raspberry Pi Foundation is licensed under a Creative Commons Attribution 4.0 International Licence.

Based on a work at https://github.com/raspberrypi/documentation