|
| 1 | +# Contributor guidelines for the Code Editor |
| 2 | + |
| 3 | +## 1. What is the Code Editor from the Raspberry Pi Foundation? |
| 4 | + |
| 5 | +The [Raspberry Pi Foundation](https://www.raspberrypi.org/about/) is a UK-based charity with global reach. Our mission is to enable young people to realise their full potential through the power of computing and digital technologies. |
| 6 | + |
| 7 | +To support young people to learn how to code, in both formal and informal education settings, we’ve designed our [Code Editor][production] to support text-based programming languages, including Python, CSS, and HTML. |
| 8 | + |
| 9 | +## 2. Latest versioning and future releases |
| 10 | + |
| 11 | +The Code Editor from the Raspberry Pi Foundation is currently in beta. This means there may still be some issues and bugs which we’ll be working on fixing, and where contributors identify particularly useful features, we may consider implementing them. |
| 12 | + |
| 13 | +Our current priority is extending the functionality so that it supports young people to learn to code. |
| 14 | + |
| 15 | +As this project is in its infancy, we encourage contributors to check this documentation from time to time, as we refine our processes and update you on our roadmap changes. |
| 16 | + |
| 17 | +**Q3 2023 (July-Sep) priority features:** |
| 18 | +- Beta testing and iterating based on user feedback (i.e. the young people using our Code Editor) |
| 19 | +- Building better support for smaller screen devices (tablet and mobile responsiveness) |
| 20 | +- Linting and static error analysis |
| 21 | + |
| 22 | +You can track our progress for feature releases and recent changes by checking the [releases]. |
| 23 | + |
| 24 | +## 3. How you can help contribute to this project |
| 25 | + |
| 26 | +We’re happy to receive pull requests for upcoming versions to fix bugs, add features and refactor code; your suggestions will help us improve our Code Editor, so we can support more young people to learn how to code. |
| 27 | + |
| 28 | +You must sign a Contribution License Agreement (CLA) before your PR will be merged. This a one-time requirement for this project. You can read more about [Contribution License Agreements](https://en.wikipedia.org/wiki/Contributor_License_Agreement) on Wikipedia. |
| 29 | + |
| 30 | +However, you don't have to do this up-front; you can simply clone, fork, and submit your pull-request as usual. |
| 31 | + |
| 32 | +When your pull-request is created, your GitHub username is checked by a CLA bot. In the first instance the system will also tell you how you can sign the CLA. Once you have signed a CLA, the current and all future pull-requests will be labeled as cla-signed. |
| 33 | + |
| 34 | +Signing the CLA might sound scary but it's actually very simple and can be done in less than a minute. |
| 35 | + |
| 36 | +**Please note: ** We cannot guarantee that there’ll be capacity to review all pull requests and feature suggestions at this time, so we recommend checking the [releases ] and [contacting us ](mailto:[email protected]) before raising any large-scale PRs or commits. |
| 37 | + |
| 38 | +## 4. How we use your code and licensing |
| 39 | + |
| 40 | +By submitting a pull request and signing the CLA, you are agreeing to your code and contribution to this project being licensed and shared as part of [our Open Source licence][licence]. |
| 41 | + |
| 42 | +**♥️♥️♥️ Thank you! Your contribution helps us improve our products, which help young people around the world take part in digital making!** |
| 43 | + |
| 44 | +[production]: https://editor.raspberrypi.org |
| 45 | +[readme]: /README.md |
| 46 | +[releases]: https://github.com/RaspberryPiFoundation/editor-api/releases |
| 47 | +[licence]: /COPYRIGHT |
0 commit comments