explain what we expect contributions

This commit is contained in:
Sylvestre Ledru
2024-02-06 09:20:10 +01:00
parent e4bd434fb5
commit 8dbb884f49
+2 -3
View File
@@ -34,20 +34,19 @@ with uutils.
* Terts Diepraam (@tertsdiepraam on GitHub and @terts on Discord)
2. **Get comfortable with uutils.** To find a good project you need to understand the codebase. We recommend that you take a look at the code, the issue tracker and maybe try to tackle some [good-first-issues](https://github.com/uutils/coreutils/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). Also take a look at our [contributor guidelines](https://github.com/uutils/coreutils/blob/main/CONTRIBUTING.md).
3. **Find a project and a mentor.** We have a [list of potential projects](https://github.com/uutils/coreutils/wiki/GSOC-Project-Ideas) you can adapt or use as inspiration. Make sure discuss your ideas with the maintainers! Some project ideas below have suggested mentors you could contact.
4. **Write the application.** You can do this with your mentor. The application has to go through Google, so make sure to follow all the advice in Google's [Contributor Guide](https://google.github.io/gsocguides/student/writing-a-proposal).
4. **Write the application.** You can do this with your mentor. The application has to go through Google, so make sure to follow all the advice in Google's [Contributor Guide](https://google.github.io/gsocguides/student/writing-a-proposal). Please make sure you include your prior contributions to uutils in your application.
# Tips
- Make sure the project is concrete and well-defined.
- Communication is super important!
- Try to tackle some simple issues to get familiar with uutils.
- Try to tackle some issues to get familiar with uutils and demonstrate your motivation.
# Project Ideas
This page contains project ideas for the Google Summer of Code for
uutils. Feel free to suggest project ideas of your own.
[Guidelines for the project list](https://google.github.io/gsocguides/mentor/defining-a-project-ideas-list)
Summarizing that page, each project should include: