Hacktoberfest 2024
Hacktoberfest is a month-long celebration of open-source projects, their maintainers and contributors. Many component maintainers from the Gradle ecosystem, such as the Gradle plugin for Jenkins, already include their projects in Hacktoberfest.
This year, Gradle is participating in Hacktoberfest! We are looking forward to collaborating with all contributors on the featured projects, hosting online events for new open-source contributors, and sending custom Gradle goodies for those who do substantial contributions to the Gradle ecosystem.
Quick Start#
- Sign-up for Hacktoberfest on hacktoberfest.com
- Sign-up in this form for Gradle so that we can contact you and distribute swag
- Join the
#hacktoberfest
channel on the Gradle Community Slack - Check out the Featured Projects below, or choose something on your own
- Enjoy, and send some pull requests!
Also, consider joining us for Hacktoberfest events! There, we plan to provide some tips on contributing to various aspects of Gradle.
Featured Projects#
During Hacktoberfest,
you are welcome to work on any project marked with the hacktoberfest
topic on GitHub or Gitlab.
Of course, we invite you to work on the following Gradle related projects:
plugins, tools, documentation and examples.
Below, there are a few project ideas we have in mind for the event, with different levels of complexity:
- π Beginner: Learn Gradle - Gradle Basics, Java, Kotlin, Android
- β Easy: Adopt Gradle Best Practices in your projects with GitHub Actions - GitHub Actions, Scripting, Documentation
- π Easy/Medium: Expand the Gradle Cookbook - Documentation, Markdown, tech of your choice
- π Easy/Medium: Improve the Gradle Community Site (this one!) - MkDocs, Web Design, Documentation
- π Medium: Contribute to GradleUp Plugins - Java, Kotlin, Android, Documentation
- π Medium: Stabilize support for ViteJS - Kotlin, JavaScript ecosystem, Gradle
- π οΈ Medium/Advanced: Configuration Cache Compatibility in Plugins - Java, Kotlin, Gradle
π Learn Gradle#
If you are just starting out with Gradle, you can learn through common Java, Kotlin or Android projects.
- Learn Gradle Build Tool with free courses on DPE University. Learn Gradle features, create new repositories while learning, and make sure to mark them with
#hacktoberfest
! - If you see any issues with the documentation or samples, please submit issues or pull requests. They count towards Hacktoberfest.
More advanced users can also experiment with Declarative Gradle and share their feedback. See the Getting Started Guide for the pointers.
To discuss your learning experiences, use the #docs
channel on the Community Slack.
β Adopt Gradle Best Practices in your GitHub Actions#
We invite everyone to adopt Gradle & GitHub Actions best practices. You can:
- Make them safer by enabling the Dependency Submission Action to detect vulnerable dependencies with - How To
- Adopt the
setup-gradle
action to enable Build Caching in your builds - Connect them to Gradle Build Scan to get better insights and troubleshooting experience - How To
- Update documentation for the Actions, based on your experiences (GitHub Repo, GRadle Cookbook Pages)
To tag your patches for Hacktoberfest,
please reference this ticket
in the pull requests,
and add the hacktoberfest
topic.
References:
- GitHub Repository
- Discuss:
#github-integrations
channel on the Community Slack
π οΈ Configuration Cache Compatibility in Plugins#
In the upcoming Gradle 9.0 release, we plan to recommend enabling the Gradle Configuration Cache by default. It will greatly speed up all aspects of Gradle by caching the Gradle work graph created during the configuration phase. There have been compatibility issues in plugins, and some are yet to be discovered and fixed. Hence, we invite contributors to work on updating the plugin ecosystem, and to test your builds for Configuration Cache compatibility.
References:
- List of plugin statuses and open issues, including known issues up for grabs
- How To: Fixing Configuration Cache issues
- Discuss:
#configuration-cache
channel on the Community Slack
π Expand the Gradle Cookbook#
We are working on the Gradle Cookbook - a new community resource with recipes for cases that are not included in the main Gradle documentation, including tool integrations, solutions for specific languages, and tech stacks (e.g. Android), tips on troubleshooting and plugin development.
You are welcome to create new recipes, or to update the existing ones. For example, we know that some CI recipes are dated, and contributions are needed!
References:
- Contributing to the Gradle Cookbook
- Open Issues
- Discuss:
#docs
channel on the Community Slack
π Contribute to GradleUp Plugins#
GradleUp is a new GitHub organization focusing on simplifying Java, Kotlin and Android development with Gradle. The team nominated a few projects for Hacktoberfest: Shadow Plugin, Static Analysis Plugin, Gratatouille, etc. Contributions to other projects are welcome, too!
References:
- Contributing to GradleUp
- Suggested GitHub Issues
- Discuss:
#gradleup
channel on the Community Slack
π Improve the Community Site#
We created this community site in early 2024, and there are many improvements to be done! Improving the look & feel, creating new content, etc... All patches are welcome!
References:
π Stabilize support for ViteJS#
OpenSavvy is working on bringing the ViteJS bundler to the Gradle Build Tool, in particular for the Kotlin Multiplatform stack. The initial version works on simple projects, but breaks when used with some configurations or libraries. We're searching for contributors who can help us understand what goes wrong so we can stabilize and release the project.
References:
- Repository
- Documentation
- Suggested GitLab issues
- Discuss:
#opensavvy
in the Kotlin Slack, or by commenting on issues
ΒΏMore Featured Projects?#
During the Hacktoberfest, maintainers are welcome to add their project if they provide contributor guidelines and issues that can be worked on by contributors.
If you want to add your project, add a hacktoberfest
topic to it and submit a pull request to this page.
It counts as a contribution, too
Swag#
In addition to our Hacktoberfest swag, we plan to send something nice to those who make substantial contributions to Gradle Build Tool and its ecosystem. Make sure to register in Our Sign-Up Form so that we can discover your contributions.
Events#
We plan some online events during October, with a goal to help with contributions. Those events will be recorded:
- October 02, 14:00 UTC - Opening Office Hours and Q&A. The link will be shared soon.
Info
More events are coming soon! We plan a few presentations and office hours for new contributors to open source.
Stay Informed#
Join the #hacktoberfest
channel on the Gradle Community Slack
where we will be posting key updates and answering questions.
For future events, subscribe to the newsletter for updates
about the upcoming community events and mentorship programs,
and also follow them on the #community-news
channel.