Update the ReadMe by Pnkcaht · Pull Request #11147 · jenkinsci/jenkins

Pnkcaht · 2025-10-02T23:55:18Z

N/A – Moderate documentation improvement, no issues with Jira.

Tests completed

N/A – Changes only to Markdown. No functional code affected.

Proposed changelog entries

Improve README.md with a better structure, usage instructions, and a table of contents to improve the visuals and efficiency of the readme documentation, guidelines for contributors, and clarity in explanations with more content and even photos showing the user what the site looks like.

Proposed changelog category

/label skip-changelog

Proposed update guidelines

N/A

welcome · 2025-10-02T23:55:21Z

Yay, your first pull request towards Jenkins core was created successfully! Thank you so much!

A contributor will provide feedback soon. Meanwhile, you can join the chats and community forums to connect with other Jenkins users, developers, and maintainers.

Pnkcaht · 2025-10-02T23:58:14Z

Hello, I've noticed the lack of content in the readme for some time now. Even though it's not that important, it helps a lot, and I've made the adjustments. If you need more content, if something is wrong or broken, or if I need to change the position, please let me know. Thank you, and I'm happy to help the Jenkins community. ❤️

MarkEWaite

Thanks for your interest in contributing to Jenkins. Unfortunately, there are many errors in your proposed changes.

The pull request would have benefited significantly if you had checked that the commands work that are included in the pull request.

This looks like it might have been generated by AI without sufficient proofreading by the user submitting the text. Please spend your time as a contributor to assure that the pull request is accurate. There are many more contributors than there are reviewers.

README.md

MarkEWaite

The formatting of the file needs to be corrected as well. Instructions for formatting are included in the contributing guide.

Pnkcaht · 2025-10-03T02:36:14Z

I agree, I saw it here and it really does contain errors, I will resolve them immediately and ensure everything is 100% correct to be finalized ❤️

Also format with `yarn lint:fix` as noted in the contributing guide.

MarkEWaite · 2025-10-03T04:11:45Z

In the future, please use a branch that is named something other than master. When you use the branch named master, you complicate your local work with the repository and you complicate the work of the reviewer.

Pnkcaht · 2025-10-03T05:27:07Z

Okay, thanks for the feedback. I won't be adding that branch name in future contributions. Do you think anything else is needed in the ReadMe?

MarkEWaite

Looks good

MarkEWaite · 2025-10-03T23:00:19Z

Okay, thanks for the feedback. I won't be adding that branch name in future contributions. Do you think anything else is needed in the ReadMe?

I didn't see anything missing in my first review, but I'll leave the pull request open to wait for a second review.

lemeurherve · 2025-10-03T23:32:34Z

README.md

+- Check our [friendly issues](https://issues.jenkins.io/issues/?jql=labels%20%3D%20newbie-friendly%20AND%20resolution%20is%20empty%20AND%20component%20%3D%20core)
+- Join our [Gitter chat](https://app.gitter.im/#/room/#jenkinsci_newcomer-contributors:gitter.im) for questions and help
+- Read the [Contribution Guidelines](CONTRIBUTING.md)


Suggested change

- Check our [friendly issues](https://issues.jenkins.io/issues/?jql=labels%20%3D%20newbie-friendly%20AND%20resolution%20is%20empty%20AND%20component%20%3D%20core)

- Join our [Gitter chat](https://app.gitter.im/#/room/#jenkinsci_newcomer-contributors:gitter.im) for questions and help

- Read the [Contribution Guidelines](CONTRIBUTING.md)

- Read the [Contribution Guidelines](CONTRIBUTING.md)

- Check our [friendly issues](https://issues.jenkins.io/issues/?jql=labels%20%3D%20newbie-friendly%20AND%20resolution%20is%20empty%20AND%20component%20%3D%20core)

- Join our [Gitter chat](https://app.gitter.im/#/room/#jenkinsci_newcomer-contributors:gitter.im) for questions and help

Suggestion: read CONTRIBUTING.md first

README.md

lemeurherve · 2025-10-03T23:37:17Z

README.md


-Jenkins is used by millions of users and thousands of companies.
-See [adopters](https://www.jenkins.io/project/adopters/) for the list of Jenkins adopters and their success stories.
+Jenkins is trusted by **millions of users** and adopted by **thousands of companies** around the world — from startups to enterprises — to automate their software delivery pipelines.


Personal opinion: not sure about that change, the "adopted" seems a bit strange to me (then english is not my native language)

Also, do we really want those em-dashes? 😅

lemeurherve · 2025-10-03T23:39:20Z

README.md

-See [adopters](https://www.jenkins.io/project/adopters/) for the list of Jenkins adopters and their success stories.
+Jenkins is trusted by **millions of users** and adopted by **thousands of companies** around the world — from startups to enterprises — to automate their software delivery pipelines.
+
+Explore the [Adopters Page](https://www.jenkins.io/project/adopters/) to see:


Suggested change

Explore the [Adopters Page](https://www.jenkins.io/project/adopters/) to see:

Explore the [Adopters Page](https://www.jenkins.io/project/adopters/) and https://stories.jenkins.io to see:

suggestion: add stories.jenkins.io link

lemeurherve · 2025-10-03T23:40:23Z

README.md


+---
+
+# 📌 Table of Contents


Suggested change

# 📌 Table of Contents

# Table of Contents

Personal opinion: there is currently no emoji on the README, I would avoid adding one.

I'll leave it to the reader's eyes, it makes it easier and provides more clarity, but I'll remove it as you asked.

Pnkcaht · 2025-10-03T23:59:34Z

@lemeurherve I have already applied the changes you requested, thank you, I think it is now ok for the merge

lemeurherve · 2025-10-05T14:57:32Z

@Vyzer9 can you keep conversations unresolved until there is a change or acknowlegment please? (ex: #11147 (comment))

It makes it easier to follow for everyone.

Pnkcaht · 2025-10-05T18:18:48Z

@lemeurherve Ok, I've already left it as unresolved, the other brother reviewed and approved the others.

Pnkcaht · 2025-10-05T19:07:29Z

@lemeurherve I left it there as unresolved but I have already made all the requested changes, I will be waiting for the response and possible merge

A1exKH

LGTM.

MarkEWaite

Issue tracker is moving to GitHub issues on Monday. I asked about the 'good first issue' label in a post to the developer list.

MarkEWaite · 2025-11-22T13:20:16Z

README.md

+New to open source or Jenkins? Here’s how to get started:
+
+- Read the [Contribution Guidelines](CONTRIBUTING.md)
+- Check our [friendly issues](https://issues.jenkins.io/issues/?jql=labels%20%3D%20newbie-friendly%20AND%20resolution%20is%20empty%20AND%20component%20%3D%20core)


This will need to be revised Monday Nov 24, 2025 when the issue tracking for Jenkins core moves from Jenkins Jira to GitHub issues.

MarkEWaite

URL for good first issues needs to be updated now that we've switched Jenkins core issues from Jira to GitHub.

README.md

MarkEWaite

This PR is now ready for merge. We will merge it after approximately 24 hours if there is no negative feedback.

/label ready-for-merge

welcome · 2025-12-01T23:49:23Z

Congratulations on getting your very first Jenkins core pull request merged 🎉🥳

This is a fantastic achievement, and we're thrilled to have you as part of our community! Thank you for your valuable input, and we look forward to seeing more of your contributions in the future!

We would like to invite you to join the community chats and forums to meet other Jenkins contributors 😊
Don't forget to check out the participation page to learn more about how to contribute to Jenkins.

* Update README.md * Update README.md * Update README.md * Remove link to non-existent newsletter Also format with `yarn lint:fix` as noted in the contributing guide. * Update README.md * Update good first issues query --------- Co-authored-by: Mark Waite <mark.earl.waite@gmail.com> Co-authored-by: Kris Stern <krisstern@outlook.com>

Update README.md

a75360d

comment-ops-bot bot added the skip-changelog Should not be shown in the changelog label Oct 2, 2025

MarkEWaite reviewed Oct 3, 2025

View reviewed changes

MarkEWaite changed the title ~~Important update to the ReadMe~~ Update the ReadMe Oct 3, 2025

MarkEWaite requested changes Oct 3, 2025

View reviewed changes

Pnkcaht and others added 3 commits October 2, 2025 23:44

Update README.md

84bcf99

Update README.md

c3a4966

Remove link to non-existent newsletter

61ac74c

Also format with `yarn lint:fix` as noted in the contributing guide.

Pnkcaht requested a review from MarkEWaite October 3, 2025 17:48

Merge branch 'master' into master

fcc70cd

MarkEWaite approved these changes Oct 3, 2025

View reviewed changes

MarkEWaite added the squash-merge-me Unclean or useless commit history, should be merged only with squash-merge label Oct 3, 2025

lemeurherve reviewed Oct 3, 2025

View reviewed changes

Update README.md

2858eb4

Merge branch 'master' into master

f518623

Merge branch 'master' into master

74ce300

A1exKH approved these changes Oct 7, 2025

View reviewed changes

Merge branch 'master' into master

e6a4130

krisstern approved these changes Oct 10, 2025

View reviewed changes

Merge branch 'master' into master

1d9d563

Merge branch 'master' into master

2fc30d0

MarkEWaite reviewed Nov 22, 2025

View reviewed changes

MarkEWaite requested changes Nov 30, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

MarkEWaite added 2 commits November 30, 2025 05:27

Update good first issues query

2c37311

Merge branch 'master' into master

709f36e

MarkEWaite self-requested a review November 30, 2025 12:27

MarkEWaite approved these changes Nov 30, 2025

View reviewed changes

comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Nov 30, 2025

MarkEWaite merged commit 6731b97 into jenkinsci:master Dec 1, 2025
18 checks passed

lemeurherve mentioned this pull request Jan 15, 2026

[pkg.origin.jenkins.io] sync.sh and puppet agent competes to update the jenkins repo keys jenkins-infra/jenkins-infra#3364

Closed

	Explore the [Adopters Page](https://www.jenkins.io/project/adopters/) to see:
	Explore the [Adopters Page](https://www.jenkins.io/project/adopters/) and https://stories.jenkins.io to see:

Uh oh!

Conversation

Pnkcaht commented Oct 2, 2025

Tests completed

Proposed changelog entries

Proposed changelog category

Proposed update guidelines

Uh oh!

welcome bot commented Oct 2, 2025

Uh oh!

Pnkcaht commented Oct 2, 2025

Uh oh!

MarkEWaite left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MarkEWaite left a comment

Choose a reason for hiding this comment

Uh oh!

Pnkcaht commented Oct 3, 2025

Uh oh!

MarkEWaite commented Oct 3, 2025

Uh oh!

Pnkcaht commented Oct 3, 2025

Uh oh!

MarkEWaite left a comment

Choose a reason for hiding this comment

Uh oh!

MarkEWaite commented Oct 3, 2025

Uh oh!

lemeurherve Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lemeurherve Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

lemeurherve Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

lemeurherve Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Pnkcaht Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Pnkcaht commented Oct 3, 2025

Uh oh!

lemeurherve commented Oct 5, 2025

Uh oh!

Pnkcaht commented Oct 5, 2025

Uh oh!

Pnkcaht commented Oct 5, 2025

Uh oh!

A1exKH left a comment

Choose a reason for hiding this comment

Uh oh!

MarkEWaite left a comment

Choose a reason for hiding this comment

Uh oh!

MarkEWaite Nov 22, 2025

Choose a reason for hiding this comment

Uh oh!

MarkEWaite left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MarkEWaite left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!