Updated Google Summer of Code 2016 (markdown)
parent
4254712ce3
commit
eb09b1487d
|
@ -14,6 +14,8 @@ OpenKeychain can be installed from [Google Play](https://play.google.com/store/a
|
||||||
* Solid understanding of Java
|
* Solid understanding of Java
|
||||||
* Knowledge of OpenPGP ([RFC 4880](https://tools.ietf.org/html/rfc4880)) is recommended
|
* Knowledge of OpenPGP ([RFC 4880](https://tools.ietf.org/html/rfc4880)) is recommended
|
||||||
|
|
||||||
|
Keep in mind that mentoring is about providing guidance to help you solve your task, but we don't want to keep holding your hand all the way. It's important for us to know that you can code and solve technical challenges on your own, while also maintaining a constructive dialogue of relevant design decisions with us.
|
||||||
|
|
||||||
# Contribution Guidelines
|
# Contribution Guidelines
|
||||||
1. Join the development mailinglist at https://lists.riseup.net/www/subscribe/openkeychain
|
1. Join the development mailinglist at https://lists.riseup.net/www/subscribe/openkeychain
|
||||||
2. Read the [README](https://github.com/openpgp-keychain/openpgp-keychain/blob/master/README.md), especially the notes about coding style
|
2. Read the [README](https://github.com/openpgp-keychain/openpgp-keychain/blob/master/README.md), especially the notes about coding style
|
||||||
|
@ -21,8 +23,6 @@ OpenKeychain can be installed from [Google Play](https://play.google.com/store/a
|
||||||
4. If you have questions ask on the mailinglist, or in #openkeychain on irc.freenode.net!
|
4. If you have questions ask on the mailinglist, or in #openkeychain on irc.freenode.net!
|
||||||
5. Open a pull request on Github. We will help with occurring problems and merge your changes back into the main project.
|
5. Open a pull request on Github. We will help with occurring problems and merge your changes back into the main project.
|
||||||
|
|
||||||
We are happy about every code contribution and appreciate your effort to help us developing OpenKeychain!
|
|
||||||
|
|
||||||
# "One patch" rule
|
# "One patch" rule
|
||||||
We require one accepted patch (pull request) from each potential GSoC student, before accepting the student for GSoC participation.
|
We require one accepted patch (pull request) from each potential GSoC student, before accepting the student for GSoC participation.
|
||||||
The reason for this requirement is that you can show us that you have succeeded in building OpenKeychain, and that you have understood a little piece of OpenKeychain's code and are able to improve it.
|
The reason for this requirement is that you can show us that you have succeeded in building OpenKeychain, and that you have understood a little piece of OpenKeychain's code and are able to improve it.
|
||||||
|
@ -30,11 +30,12 @@ This requirement is based on the "two patches" rule applied by projects such as
|
||||||
|
|
||||||
To make it easier for you to get started, we picked some (hopefully) easy issues for this purpose: https://github.com/openpgp-keychain/openpgp-keychain/issues?labels=simple-one-patch&page=1&state=open
|
To make it easier for you to get started, we picked some (hopefully) easy issues for this purpose: https://github.com/openpgp-keychain/openpgp-keychain/issues?labels=simple-one-patch&page=1&state=open
|
||||||
|
|
||||||
|
Keep in mind that mentoring is about providing guidance to help you solve your task, but we don't want to keep holding your hand all the way. It's important for us to know that you can code and solve technical challenges on your own, while also maintaining a constructive dialogue of relevant design decisions with us.
|
||||||
|
|
||||||
# Google Summer of Code Registration Procedure
|
# Google Summer of Code Registration Procedure
|
||||||
1. Have one patch accepted in OpenKeychain (see "one patch" rule)
|
1. Have one patch accepted in OpenKeychain (see ["one patch" rule](https://github.com/open-keychain/open-keychain/wiki/Google-Summer-of-Code-2016#one-patch-rule))
|
||||||
2. Lookout for interesting ideas on this page and choose multiple according to the time you expect to work on them. You can also propose your own ideas
|
2. Lookout for interesting tasks on the [Ideas page in our wiki](https://github.com/open-keychain/open-keychain/wiki/Google-Summer-of-Code-2016), then choose one you would like to work on. If you have an interesting task of your own in mind, you can also propose your own ideas - if you do, make sure to leave enough time to discuss it with us!
|
||||||
3. Tell us about your plans on the mailinglist
|
3. [Apply officially on the Google Summer of Code page](https://summerofcode.withgoogle.com/org-signup/) (**Registration opens on March 14th 2016**). In your proposal, outline your understanding of the task you picked. This should include a description of the task from your perspective, challenges and design decisions you expect to encounter along the way, and a rough timeline for your implementation ideally based around four milestones (i.e., one every three weeks). Make sure to allocate some time for writing tests and code review!
|
||||||
4. [Apply officially on the Google Summer of Code page](https://summerofcode.withgoogle.com/) (**Registration opens on March 14th 2016**)
|
|
||||||
|
|
||||||
# Evaluation
|
# Evaluation
|
||||||
GSoC has two formal evaluation points, at the mid-term and at the end. These evaluations determine if you receive the stipend from Google. In order to receive a pass for the evaluations you will need to show adequate progress toward your project's goals. We have a number of mechanisms to help you meet your goals and get in touch with us and other developers:
|
GSoC has two formal evaluation points, at the mid-term and at the end. These evaluations determine if you receive the stipend from Google. In order to receive a pass for the evaluations you will need to show adequate progress toward your project's goals. We have a number of mechanisms to help you meet your goals and get in touch with us and other developers:
|
||||||
|
@ -267,4 +268,4 @@ dialog.
|
||||||
|
|
||||||
**Contact:** [Mailinglist](https://lists.riseup.net/www/subscribe/openkeychain)
|
**Contact:** [Mailinglist](https://lists.riseup.net/www/subscribe/openkeychain)
|
||||||
or on IRC (Valodim in [#openkeychain at
|
or on IRC (Valodim in [#openkeychain at
|
||||||
irc.freenode.net](https://kiwiirc.com/client/irc.freenode.net/openkeychain))
|
irc.freenode.net](https://kiwiirc.com/client/irc.freenode.net/openkeychain))
|
Loading…
Reference in New Issue