diff --git a/Google-Summer-of-Code-2023-Ideas.md b/Google-Summer-of-Code-2023-Ideas.md index f462837..997ac1c 100644 --- a/Google-Summer-of-Code-2023-Ideas.md +++ b/Google-Summer-of-Code-2023-Ideas.md @@ -19,37 +19,23 @@ The Borg Collective is part of the Python Software Foundation. Please read about ## Getting Started -Get in touch on [Github](https://github.com/borgbase/vorta/issues/1583) or [IRC](https://matrix.to/#/#vorta:matrix.org) and tell us that you are interested in one of our projects. This doesn't represent any commitment to apply as a contributor. You can choose to apply for a different project at any time. +1. Get in touch on [Github](https://github.com/borgbase/vorta/issues/1583) or [IRC](https://matrix.to/#/#vorta:matrix.org) and tell us that you are interested in one of our projects. This doesn't represent any commitment to apply as a contributor. You can choose to apply for a different project at any time. +2. Select an easy issue which are tagged/labelled with `good first issue` and try solving it. (view such issues in each project: [Vorta](https://github.com/borgbase/vorta/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), [Borg](https://github.com/borgbackup/borg/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), [Borgmatic](https://projects.torsion.org/borgmatic-collective/borgmatic/issues?q=&type=all&state=open&labels=52&milestone=0&assignee=0&poster=0)) This allows you to get to know the project and its source code. This helps you determining whether it suits you and whether you want to apply as a contributor. Solving an issue and opening a pull request (PR) for it, will also be required for applying. +3. Before working on an issue, please comment and make sure it's assigned to you, so no duplicate work is done. Also outline *how* you plan on solving the issue, so you are on the right track from the start. We can give you some hints on how to go about, but we also want to see how you manage on your own. +4. Open a PR fixing the issue. We will then review it as usual. Don't feel discouraged if the reviewer requests changes to your PR. This doesn't question your skills. We just want the code to meet our (formal) standards. +5. When you are sure that you want to apply as a contributor to one of our projects, it is time to discuss the [project ideas](#project-ideas) that you are interested in with your prospected mentors. Make sure to communicate your current knowledge and expertise so that your prospected mentors can guide you adequately. After this step you should have a clear understanding of task you will apply for including expected results, tasks and steps towards that goal, time effort. +6. Your prospective mentors will then help you with writing your application. It is very important to check in with them on your application before submitting. Else your likelihood of being accepted shrinks drastically. -We encourage you to select an easy issue which are tagged/labelled with `good first issue` and try solving it. -This allows you to get to know the project and its source code. This helps you determining whether it suits you and whether you want to apply as a contributor. Solving an issue and opening a PR for it, will also be required for applying. - -Before coding, you should install and try out the program you are interested in from a user perspective. +During all steps communication is key. Talk to the mentors as well as other community members, take their feedback and advise into account. To start coding, see the existing contributor guides for each project and setup your development environment: - [Vorta](https://vorta.borgbase.com/contributing/) - [Borg Backup](https://borgbackup.readthedocs.io/en/stable/development.html) - [Borgmatic](https://torsion.org/borgmatic/#support-and-contributing) -Before working on an issue, please comment and make sure it's assigned to you, so no duplicate work is done. Also outline *how* you plan on solving the issue, so you are on the right track from the start. -We can give you some hints on how to go about, but we also want to see how you manage on your own. -Open a pull request (PR) fixing the issue. -We will then review it as usual. Don't feel discouraged if the reviewer requests changes to your PR. -This doesn't question your skills. We just want the code to meet our (formal) standards. - -Feel free to ask questions. -On your journey you might encounter unclear, insufficient or missing documentation. +Feel free to ask questions. On your journey you might encounter unclear, insufficient or missing documentation. Don't hesitate to point out the problems, so we can help you out as well as improve the documentation of our projects. -When you are sure that you want to apply as a contributor to one of our projects, -it is time to discuss the project ideas that you are interested in with your prospected mentors. -Make sure to communicate your current knowledge and expertise so that your prospected mentors can guide you adequately. -After this step you should have a clear understanding of task you will apply for including -expected results, tasks and steps towards that goal, time efford. - -Your prospected mentors will then help you with writing your application. It is very important to check in with them on your application before submitting. Else your likelyhood of being accepted shrinks drastically. - -During all steps communication is key. Talk to the mentors as well as other community members, take their feedback and advise into account.