Skip to content

Commit cc9c212

Browse files
Merge pull request #80 from gradle/hacktoberfest-live
Update the Hacktoberfest landing before the event starts
2 parents 988b9ed + 5401dcf commit cc9c212

6 files changed

Lines changed: 165 additions & 36 deletions

File tree

.vscode/settings.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"cSpell.words": [
3+
"gradleup",
4+
"Gratatouille",
5+
"Multiplatform"
6+
]
7+
}

docs/events/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,7 @@ we might be able to host something in the community for a particular initiative.
4646
If you are a maintainer or an active contributor interested in doing mentorship,
4747
reach out to us on the `#contributing` channel.
4848

49-
## Other Events
50-
51-
### Hacktoberfest
49+
## Hacktoberfest
5250

5351
[Hacktoberfest](https://hacktoberfest.com/) is a month-long celebration of open-source projects, their maintainers, and the entire community of contributors.
5452
Many component maintainers from the Gradle ecosystem, e.g. the
@@ -58,6 +56,12 @@ already include their projects in Hacktoberfest.
5856
In 2024, we plan to participate as an organization,
5957
and to offer nice special-edition swag to the key contributors.
6058

59+
## Events Archive
60+
61+
In the past we also hosted or participated in the following events:
62+
63+
- [Major League Hacking Fellowship Program 2023](https://news.mlh.io/major-league-hacking-partners-with-gradle-to-empower-the-next-generation-of-open-source-leaders-09-28-2023)
64+
- [Gradle Configuration Cache Hackathon 2022](https://github.com/gradle/cc-hackathon-2022)
6165

6266
## Stay Informed
6367

docs/events/hacktoberfest/2024/README.md

Lines changed: 149 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,65 +6,183 @@ description: >
66
and get custom swag!
77
---
88

9-
[![Slack: hacktobest on the Gradle Community Slack](https://img.shields.io/badge/Slack-%23hacktoberfest-brightgreen?style=flat&logo=slack)](../../../contributing/community-slack.md)
9+
[![Slack: Hacktoberfest on the Gradle Community Slack](https://img.shields.io/badge/Slack-%23hacktoberfest-brightgreen?style=flat&logo=slack)](../../../contributing/community-slack.md)
1010

1111
[Hacktoberfest](https://hacktoberfest.com/) is a month-long celebration of open-source projects, their maintainers and contributors.
1212
Many component maintainers from the Gradle ecosystem, such as the
1313
[Gradle plugin for Jenkins](https://plugins.jenkins.io/gradle),
1414
already include their projects in Hacktoberfest.
1515

1616
This year, Gradle is participating in Hacktoberfest!
17-
We are looking forward to featuring projects, hosting online events for new open-source contributors,
18-
and sending custom Gradle goodies for those who contribute to the projects.
17+
We are looking forward to collaborating with all contributors on the featured projects, hosting online events for new open-source contributors,
18+
and sending custom Gradle goodies for those who do substantial contributions to the Gradle ecosystem.
1919

20-
<a class="button button--blue"
21-
href="https://forms.gle/avUcGctpzW3t8MPJ7"
22-
target="_blank">Sign Up for Updates
23-
</a>
20+
## Quick Start
21+
22+
1. Sign-up for Hacktoberfest on [hacktoberfest.com](https://hacktoberfest.com/)
23+
2. Sign-up in [this form for Gradle](https://forms.gle/go2VESj7kDG1QUqV7) so that
24+
we can contact you and distribute swag
25+
3. Join the `#hacktoberfest` channel on the Gradle Community Slack [](../../../contributing/community-slack.md)
26+
4. Check out the Featured Projects below, and consider joining us for Hacktoberfest events!
27+
5. Enjoy!
2428

2529
## Featured Projects
2630

27-
Here are a few projects we have in mind for the event:
31+
During Hacktoberfest,
32+
you are welcome to work on any project marked with the `hacktoberfest` topic on GitHub or Gitlab.
33+
Of course, we invite you to work on the following Gradle related projects:
34+
plugins, tools, documentation and examples.
35+
36+
Below, there are a few project ideas we have in mind for the event,
37+
with different levels of complexity:
38+
39+
- **Beginner:** [Learn Gradle](#learn) - Basics, Java, Kotlin
40+
- **Easy:** [Adopt Gradle Best Practices in your GitHub Actions](#github-actions) -
41+
GitHub Actions, Scripting, Documentation
42+
- **Advanced:** [Configuration Cache Compatibility in Plugins](#configuration-cache) -
43+
Java, Kotlin, Gradle
44+
- **Easy/Medium:** [Expand the Gradle Cookbook](#cookbook) -
45+
Documentation, Markdown, tech of your choice
46+
- **Medium:** [Contribute to GradleUp Plugins](#gradleup) -
47+
Java, Kotlin, Android, Documentation
48+
- **Easy/Medium:** [Improve this Site!](#community-site) -
49+
MkDocs, Web Design, Documentation
50+
51+
<a name="github-actions"></a>
52+
53+
### Adopt Gradle Best Practices in your GitHub Actions
54+
55+
We invite everyone to adopt [Gradle & GitHub Actions best practices](https://community.gradle.org/cookbook/ci/github-actions/).
56+
You can:
57+
58+
* Make them safer by enabling the [Dependency Submission Action](https://github.com/gradle/actions/blob/main/dependency-submission/README.md) to [detect vulnerable dependencies with](https://community.gradle.org/cookbook/ci/github-actions/#detect-vulnerable-dependencies-with-a-dependency-submission-workflow) -
59+
[How To](https://community.gradle.org/cookbook/ci/github-actions/#detect-vulnerable-dependencies-with-a-dependency-submission-workflow)
60+
* Adopt the [`setup-gradle` action](https://community.gradle.org/cookbook/ci/github-actions/) to enable [Build Caching in your builds](https://community.gradle.org/cookbook/ci/github-actions/#enable-caching-of-downloaded-artifacts)
61+
* Connect them to [Gradle Build Scan](https://docs.gradle.org/current/userguide/build_scans.html) to get better insights and troubleshooting experience - [How To](https://community.gradle.org/cookbook/ci/github-actions/#configure-github-actions)
62+
* Update documentation for the Actions, based on your experiences
63+
([GitHub Repo](https://github.com/gradle/actions), [Cookbook Pages](https://community.gradle.org/cookbook/ci/github-actions/))
64+
65+
To tag your patches for Hacktoberfest,
66+
please reference [this ticket](https://github.com/gradle/actions/issues/406)
67+
in the pull requests,
68+
and add the `hacktoberfest` topic.
69+
70+
References:
71+
72+
- [GitHub Repository](https://github.com/gradle/actions)
73+
- Discuss: `#github-integrations` channel on the Community Slack
74+
75+
<a name="configuration-cache"></a>
76+
77+
### Configuration Cache Compatibility in Plugins
78+
79+
In the upcoming Gradle 9.0, we plan to recommend enabling the [Gradle Configuration Cache](https://docs.gradle.org/current/userguide/configuration_cache.html) by default.
80+
It will greatly speed up all aspects of Gradle by caching the Gradle build graph created during the configuration phase.
81+
There have been compatibility issues in plugins,
82+
and some are yet to be discovered and fixed.
83+
Hence, we invite contributors to work on updating the plugin ecosystem,
84+
and to test your builds for Configuration Cache compatibility.
85+
86+
References:
87+
88+
- [List of plugin statuses and open issues](https://github.com/gradle/gradle/issues/13490),
89+
including known issues up for grabs
90+
- [How To: Fixing Configuration Cache issues](https://github.com/gradle/cc-hackathon-2022/blob/main/faq.md#fixing-configuration-cache-issues)
91+
- Discuss: `#configuration-cache` channel on the Community Slack
92+
93+
<a name="cookbook"></a>
94+
95+
### Expand the Gradle Cookbook
96+
97+
We are working on the [Gradle Cookbook](https://cookbook.gradle.org/) - a new community resource with recipes
98+
for cases that are not included in the main Gradle documentation,
99+
including tool integrations, solutions for specific languages and tech stacks
100+
(e.g. Android), tips on troubleshooting and plugin development.
101+
102+
You are welcome to create new recipes, or to update the existing ones.
103+
For example, we know that some CI recipes are dated, and contributions are needed!
104+
105+
References:
106+
107+
- [Contributing to the Gradle Cookbook](https://community.gradle.org/cookbook/CONTRIBUTING/)
108+
- [Open Issues](https://github.com/gradle/community/issues?q=is%3Aissue+is%3Aopen+label%3Acookbook)
109+
- Discuss: `#docs` channel on the Community Slack
28110

29-
* Making Gradle plugins compatible with Gradle Configuration Cache ([list of plugin statuses on GitHub](https://github.com/gradle/gradle/issues/13490))
30-
* Experimenting with Declarative Gradle and sharing feedback
31-
* Contributing new Gradle solutions to the [Gradle Cookbook](https://community.gradle.org/cookbook/)
32-
* Learning Gradle Build Tool with free courses on [DPE University](https://dpeuniversity.gradle.com/app/catalog)
33-
* Adopting `setup-gradle` and `dependency-submission` GitHub Actions in your projects,
34-
and connecting them to Gradle Build Scan. [HOWTO](https://community.gradle.org/cookbook/ci/github-actions/#detect-vulnerable-dependencies-with-a-dependency-submission-workflow)
35-
* Contributing to Gradle plugins maintained by the [GradleUp](https://gradleup.com/) team:
36-
Shadow Plugin, Static Analysis Plugin, Gratatouille, etc. [Full List](https://gradleup.com/projects/)
111+
<a name="gradleup"></a>
37112

38-
More featured projects, getting started guidelies and good first issues will be added soon.
39-
Maintainers are welcome to add their project if they provide contributor guidelines
40-
and issues that can be hacked on by contributors.
113+
### Contribute to GradleUp Plugins
114+
115+
[GradleUp](https://gradleup.com/) is a new GitHub organization focusing on simplifying Java, Kotlin and Android development with Gradle.
116+
The team nominated a few projects for Hacktoberfest: Shadow Plugin, Static Analysis Plugin, Gratatouille, etc. Contributions to other projects are welcome, too!
117+
118+
References:
119+
120+
- [Contributing to GradleUp](https://gradleup.com/docs/community/participate/)
121+
- Discuss: `#gradleup` channel on the Community Slack
122+
123+
<a name="learn"></a>
124+
125+
### Learn Gradle
126+
127+
If you are just starting out with Gradle,
128+
you can learn through common
129+
Java, Kotlin or Android projects.
130+
131+
* Learn Gradle Build Tool with free courses on [DPE University](https://dpeuniversity.gradle.com/app/catalog). Learn Gradle features, create new repositories while learning, and make sure to mark them with `#hacktoberfest`!
132+
* If you see any issues with the documentation or learning materials,
133+
please submit issues or pull requests.
134+
135+
More advanced users can also experiment with [Declarative Gradle](https://declarative.gradle.org/) and share their feedback.
136+
See the [Getting Started Guide](https://declarative.gradle.org/docs/getting-started/) for the pointers.
137+
138+
To discuss your learning experiences, use the `#docs` channel on the Community Slack.
139+
140+
<a name="community-site"></a>
141+
142+
### Improve the Community Site
143+
144+
We created this community site in early 2024, and there are many improvements to be done!
145+
Improving the look & feel, creating new content, etc...
146+
All patches are welcome!
147+
148+
References:
149+
150+
* [Contributing to the Community Site](./../../../CONTRIBUTING.md)
151+
* [Open Issues](https://github.com/gradle/community/labels/website)
152+
153+
## ¿More Featured Projects?
154+
155+
During the Hacktoberfest, maintainers are welcome to add their project if they provide contributor guidelines and issues that can be worked on by contributors.
156+
If you want to add your project, add a `hacktoberfest` topic to it and submit a pull request to this page.
157+
It counts as a contribution, too :wink:
41158

42159
## Swag
43160

44161
In addition to our Hacktoberfest swag,
45162
we plan to send something nice to those who make substantial contributions to
46163
Gradle Build Tool and its ecosystem.
164+
Make sure to register in [Our Sign-Up Form](https://forms.gle/go2VESj7kDG1QUqV7) so that we can discover your contributions.
47165

48-
!!! info
49-
50-
The details will be announced soon.
166+
![Hacktoberfest Swag](./images/swag.jpg)
51167

52168
## Events
53169

170+
We plan some online events during October, with a goal to help with contributions.
171+
Those events will be recorded:
172+
173+
- **October 02, 14:00 UTC** - Opening Office Hours and Q&A.
174+
The link will be shared soon.
175+
54176
!!! info
55177

56-
Coming soon.
57-
We will at least have an opening event,
58-
and also a few presentations and office hours for new contributors to open source.
178+
More events are coming soon!
179+
We plan a few presentations and office hours for new contributors to open source.
59180

60181
## Stay Informed
61182

62183
Join the `#hacktoberfest` channel on the [Gradle Community Slack](../../../contributing/community-slack.md)
63184
where we will be posting key updates and answering questions.
64-
Subscribe to the [newsletter](https://newsletter.gradle.org/) for updates
65-
about upcoming community events and mentorship programs.
66185

67-
<a class="button button--blue"
68-
href="https://forms.gle/avUcGctpzW3t8MPJ7"
69-
target="_blank">Sign Up for Updates
70-
</a>
186+
For future events, subscribe to the [newsletter](https://newsletter.gradle.org/) for updates
187+
about the upcoming community events and mentorship programs,
188+
and also follow them on the `#community-news` channel.
140 KB
Loading

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ nav:
118118
- Gradle for Kotlin: cookbook/kotlin/README.md
119119
- Gradle for Android: cookbook/android/README.md
120120
- Contributing: cookbook/CONTRIBUTING.md
121+
- Hacktoberfest 2024: events/hacktoberfest/2024/README.md
121122
- Participate:
122123
- Getting Started: contributing/README.md
123124
- Community Slack: contributing/community-slack.md

overrides/main.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
{% extends "base.html" %}
22

33
{% block announce %}
4-
Want to have better developer experience whith Gradle?
5-
We need your help, take the <a href="./surveys/developer-survey/">Gradle Developer Survey</a>!
4+
Join us for <a href="./events/hacktoberfest/2024/">Hacktoberfest 2024</a>!
65
{% endblock %}
76

87
{% block scripts %}

0 commit comments

Comments
 (0)