GSoC 2024 live blog

GSoC
1

QUICK START

  1. Watch this topic, so that you stay up to date, we are not able to update you individually!

  2. Read Contributing to Joplin | Joplin and the entire GSoC Introduction , if you have specific questions you can ask them in Development

  3. Introduce yourself in GSoC - Joplin Forum and label the topic with gsoc-2024.
    Tell a about yourself:

    • what you're currently doing
    • what experience do you have to work on Joplin
    • What is your experience using Joplin
    • How do you ensure that any project you may work on will stay well maintained in the future

  4. Fix an issue and mention it in your introduction topic, a simple reply in the topic is enough.
    The [good first issue], [bug] and [high] labels can be good places to start. The [enhancement] label could be interesting too. Otherwise don't hesitate to filter the issues by the labels that might interest you, such as "desktop", or "clipper", or "tags", etc. On GitHub, click on the "Label" header to do so.

    Moreover, there are plug-ins from past GSoC seasons that welcome support:

    1. Issues · joplin/plugin-email
    2. Issues · joplin/plugin-kanban
    3. Issues · joplin/plugin-templates
    4. Issues · joplin/plugin-conflict-resolution
    5. Issues · joplin/plugin-collaboration
    6. Issues · joplin/plugin-bibtex

    If you work on an issue of a plug-in, involve the community in GSoC Projects - Joplin Forum

    Alternatively, you can do a features request or discuss existing ones in Features. If there is positive feedback, you can create a corresponding feature request and try to realize it by doing a PR

    Issues will not be assigned to anyone! Let the community know that you are working on a fix on GitHub (and maybe in the forum if there is a related discussion).

  5. Submit your fix in a nice and clean PR and do:

    • mentioned the issue in your introduction here in the forum
    • in your PR, add the link to your introduction in the forum
    • Mention @PackElend label me please on GitHub, so that I can track your PRs by adding the label gsoc-2024
      If the PR is too bad from the start, it will be closed and won’t accept more pull request from that student.

  6. Submit Proposal
    PM @PackElend as described in GSoC 2024 live blog - #5 by PackElend

BEHAVIOR

  • If you're not familiar with something, you test it locally (in your fork) first.

  • You don’t say, it is not working and post merely the error message.
    You tell us the details about your development environment and your way to this point as well. Only this way, we can comprehend your journey in our’s mind’s eye to give the support you need.

  • If you need support, try to ask Google first, not for hours but it might be easily resolvable.

  • Then come back to the forum and ask for help. This way, you can say, I think I run into problem xy, I tried to solve it following xy but I need additional help. This gives a much better impression towards the community than just signalling SOS.

  • We can hardly give you a tight how-to-proceed here. At the end is up to you, when you want to ask the community (not a single person).

  • As all happens mainly written, there is no space for visual communication by mimic and gestic, so think before you interact with the community.

  • No worries at all, we are very open-minded and eager to help but sometimes it is just too much. At the end of the day, you are assessed by your actions.

  • If you work on an issue, you keep us updated. Running after people to ask how things are going is not fun. Drop us a little note in the forum (so the issue remains clean), so we know what is going on if you need to pause the work. That is no problem at all, as long as we are aware of it.

  • Keep in mind, what and how act here, tells a bit about yourself

  • Important: All the mentors in this project are doing this in their spare time, and this is a very busy project at the moment. They will get to your pull request eventually. Once you have mentioned @PackElend, you should not contact mentors via PM or @mention them to ask for review or feedback . Nagging contributors is, in fact, the surest way to make your pull request go down to the bottom of the pile!
    If you feel that you need to mention a Joplin team member, as there is an urgent reason to do so, you can mention @PackElend, they will respond as soon as possible.
    They will mention other team members when necessary, as they are quite occupied with taking care of the app in general and reviewing the PRs.

  • Important: here and on GitHub use mentions almost never, others are informed if you react to a post or quote their reply or just reply to a specific message. Excessive mentioning is not welcome and can drop your reputation.

  • Important: please do not reply to this topic, it is for mentors only, any post from non-mentors will be deleted without notification!

If you want to help us with mentoring projects, please write us in Mentors wanted for GSoC

9 Likes