Hacktoberfest
This site is the new docs site currently being tested. For the actual docs in use please go to https://www.jenkins.io/doc. |
Hacktoberfest is a month long celebration of open source software. It happens every year in October. During this event everyone can support open-source by contributing changes, and then earn a limited edition swag.
We invite everyone to participate and to contribute to the Jenkins project, regardless of their background and Jenkins experience. There are many ways to contribute to Jenkins during Hacktoberfest. You can work on code or documentation, contribute to localization, create new artwork, etc. You can also share your experiences with Jenkins by creating a new blogpost. Generally, any pull requests in GitHub would qualify. See the Contribute and Participate page for more information about how to contribute.
Quick start
-
Sign-up to Hacktoberfest on the event website.
-
Join our Gitter channel.
-
Everything is set, just start creating pull-requests!
-
If a repository has no
hacktoberfest
topic set, contact the maintainers to see if they are willing to accecpt a contribution.
-
Where to contribute?
The Jenkins project is spread across several organizations on GitHub (jenkinsci
, jenkins-infra
, jenkins-zh
).
You are welcome to contribute to any repository in any of those organizations, or any other Jenkins-related repository on GitHub.
Repositories may have different contribution guidelines, review and merge policies.
If you adopt Jenkins in your open-source projects (e.g. Jenkins Pipeline or Configuration as Code),
it counts as well!
Note that not all pull requests will automatically count towards Hacktoberfest.
-
List of repositories marked for Hacktoberfest - you can just submit pull requests, no extra steps needed.
-
for other repositories, we will need to get the repo marked for Hacktoberfest so that your pull request counts towards the goal. Please follow FAQ: Marking Pull requests.
Issue queries
We have marked some issues in Jenkins Jira and GitHub issues which can be handled by contributors during Hacktoberfest:
Featured projects
If you are a newcomer contributor, we have prepared a list of projects/components where you will get a warm welcome. All these projects have newbie-friendly tasks, contributing guidelines, and active maintainers who have committed to assist contributors and to provide quick turnaround in pull requests.
Project/component | Keywords | Ideas and links |
---|---|---|
Documentation, |
Extend and improve Jenkins documentation, help to improve the website’s look&feel, create a new blogpost, a technology-specific solution page or a tutorial. Contributing guidelines, Good first issues Additionally, we invite new and experienced Jenkins developers to help improve the developer documentation. If you want to learn a Jenkins development topic and share your new knowledge with others, or want to help someone else learn, you’re welcome to contribute here. |
|
Java, |
There is always something to improve in Jenkins core itself. You can address various issues, improve the codebase, and add new features there. |
|
Javascript, Java, React, Gatsby |
The plugin site is used to find information about 1800+ plugins available in Jenkins. It provides plugin documentation, changelogs, open issues, and other data needed for Jenkins admins and end users. We are interested to keep improving the plugin site’s UI/UX, provide more search options, and to provide deeper integration with GitHub and other services.
|
|
Java, Docker |
Jenkinsfile Runner is a portable Jenkins Pipeline execution engine, currently in preview. It can run as a standalone CLI tool or as a Docker container. We invite Hacktoberfest participants to evaluate the tool, work on adding new features and demos, |
|
Java, Prometheus |
Jenkins Prometheus Plugin expose an endpoint (default /prometheus) with metrics where a Prometheus Server can scrape. We invite Hacktoberfest participants to evaluate the plugin, work on adding new features, and documentation. |
|
Java, Tekton, Kubernetes |
The Tekton Client Plugin allows Jenkins users to trigger the creation and deletion of Tekton Pipelines and other resources. We invite Hacktoberfest participants to evaluate the plugin, work on adding new features, and documentation. |
|
Design |
Create new images and logos for Jenkins area meetups, subprojects, and plugins. You can also contribute new graphics to plugins. |
|
Kubernetes, Helm, Documentation |
|
|
Markdown, |
We are moving plugin documentation from Jenkins Wiki to GitHub, and it is a great opportunity to create small pull requests that benefit all Jenkins users.
|
|
French translation |
Git, French, Jenkins developer tools |
Improve coverage of French localization of the Jenkins web interface, including the Jenkins core and plugins. The same is possible for other languages, let us know if you are interested!
|
Asciidoctor, Docker, Github Actions, Jenkins Pipeline, Kubernetes, Markdown, Packer, Puppet, Python, Shell, YAML |
An infrastructure is constantly moving forward: there are always dependencies to update, security issues to fix, new feature to release, tools to improve, etc. Any kind of contribution is welcome: from documentation to real life code. Either you are a beginner in this area, or a veteran of system administration, you are welcome to pick an issue and contribute!
|
|
Content Security Policy (CSP) |
JavaScript, Jelly, Security |
During the last years, the Jenkins Security team has seen a lot of Cross-Site Scripting (XSS) vulnerabilities, inside Jenkins core and also for a lot of plugins. They have put in place different kinds of mechanisms to enhance the protection of some of the common dangerous code locations. But this kind of approach does not scale enough to cover the wide ecosystem and the numerous different ways of introducing (accidentally) XSS vulnerabilities. The objective of this topic is to ease the introduction of CSP in Jenkins by un-inlining the JavaScript resources.
More details on the approach in this document. |
Experienced developers
If you are an established developer and want to create something new, please don’t let yourself to be blocked by the suggested topics! Feel free to contribute to any area of Jenkins. If you see any major functionality missing in Jenkins, we invite you to create new plugins. See the Plugin Tutorial and Hosting Plugins guidelines for more information.
Events
Hacktoberfest is a fully online event this year. Jenkins specific events for Hacktoberfest will be announced on the events page, in social media (twitter and LinkedIn), and through the Jenkins Online Meetup page.
We are also looking for event organizers and sponsorsS! See our Event Kit for more information and guidelines.
Resources
-
Presentation: Contributing to Jenkins - It Is All About You (slides)
Contact us
-
Gitter: jenkinsci/hacktoberfest
-
GitHub: @jenkinsci/hacktoberfest, @jenkins-infra/hacktoberfest