Update the ReadMe #11147
Update the ReadMe #11147
Conversation
|
Yay, your first pull request towards Jenkins core was created successfully! Thank you so much! |
|
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. ❤️ |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
The formatting of the file needs to be corrected as well. Instructions for formatting are included in the contributing guide.
|
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.
|
In the future, please use a branch that is named something other than |
|
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
added
the
squash-merge-me
I didn't see anything missing in my first review, but I'll leave the pull request open to wait for a second review. |
README.md
Outdated
| - 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) |
There was a problem hiding this comment.
| - 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
|
|
||
| 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. |
There was a problem hiding this comment.
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? 😅
README.md
Outdated
| 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: |
There was a problem hiding this comment.
| 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
README.md
Outdated
|
|
||
| --- | ||
|
|
||
| # 📌 Table of Contents |
There was a problem hiding this comment.
| # 📌 Table of Contents | |
| # Table of Contents |
Personal opinion: there is currently no emoji on the README, I would avoid adding one.
There was a problem hiding this comment.
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.
|
@lemeurherve I have already applied the changes you requested, thank you, I think it is now ok for the merge |
|
@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. |
|
@lemeurherve Ok, I've already left it as unresolved, the other brother reviewed and approved the others. |
|
@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 |
5 participants
N/A – Moderate documentation improvement, no issues with Jira.
Tests completed
N/A – Changes only to Markdown. No functional code affected.
Proposed changelog entries
Proposed changelog category
/label skip-changelog
Proposed update guidelines
N/A