Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!

If you have contributed before, consider leaving this one for someone new, and looking through our general ideal-for-contribution issues. Thanks!

Problem

The documentation for disabling specific auto-configuration describes how to use the exclude attribute on @EnableAutoConfiguration, but a typical Spring Boot application will use @SpringBootApplication rather than @EnableAutoConfiguration.

Solution

The documentation should be updated to describe and demonstrate the use of the exclude attribute on @SpringBootApplication rather than @EnableAutoConfiguration. A sentence should be added after the example to note that, if you are using @EnableAutoConfiguration rather than @SpringBootApplication, it has an exclude attribute that can be used.

The following changes should be made:

  • Update the description to describe @SpringBootApplication rather than @EnableAutoConfiguration
  • Update the example to use @SpringBootApplication rather than @EnableAutoConfiguration
  • Add a sentence before this one that lets the user know that if they are using @EnableAutoConfiguration rather than @SpringBootApplication it has an exclude attribute that they can use for the same purpose.

Steps to Fix

  • [x] Claim this issue with a comment below and ask any clarifying questions you need
  • [x] Set up a repository locally following the Contributing Guidelines
  • [x] Try to fix the issue following the steps above
  • [x] Commit your changes and start a pull request.

Comment From: protyay

Hello, I would like to work on this issue. Can you please guide me ?

Comment From: wilkinsona

Excellent. Thanks very much, @protyay. Please let us know what guidance you need in addition to the steps described above, and we'll do our best to help.

Comment From: protyay

Thanks. I'll begin by setting up the project locally and will ask the follow-up questions, if any.

Comment From: vsethi13

Ahh.. I missed it by 30 mins :)

Comment From: protyay

Hello @wilkinsona , I've made the suggested changes and the updated HTML snippet is attached. I've also signed the contributor license.

I need some help regarding the workflow for submitting the PR. ( Fork/Clone/Commit/Push/Submit PR?)

Snippet springboot Update documentation on excluding an auto-configuration to recommend exclude on SpringBootApplication

Comment From: wilkinsona

Thanks for the update, @protyay. It's looking good.

I can see that you already have a fork so the next step is to commit and push the changes that you have made. Once that's done you can open a pull request. GitHub's help documentation on collaborating with issues and pull requests provides a good overview of what needs to be done, particularly the section on proposing changes with a pull request and creating a pull request.

Please have a read of the links above and then if you have any specific questions please ask here and we'll do our best to answer them.

Comment From: 2wkamd

Hi @wilkinsona thanks for firs-time-only issue I start contributing Can you check if I did the task correct? I don't know if the branches are correct and execute the pull request correctly.

Comment From: wilkinsona

@2wkamd Thank you, but as indicated above, @protyay has already claimed this one and is working on it. If they need to drop out for some reason @vsethi13 is next in line.

Comment From: 2wkamd

OK, I think I misunderstood the process to claim issue. Thanks @wilkinsona.

Comment From: protyay

Hello, @wilkinsona . I've created the pull request. Please review & merge PR-Spring Boot Doc Update

Comment From: wilkinsona

Thanks very much, @protyay. Closing in favour of #19855.

Comment From: protyay

Great. I'm looking to work on other issues. Is there a specific rules to assign tasks to yourself ? @wilkinsona

Comment From: snicoll

@protyay issues that are assigned are not open for contributions as work may have already started, leading to duplicate efforts. If you are interested by an unassigned issue and want to work on it, just add a comment (alongside any question you may have) and we'll assign spring-contributor, as we did in this very issue.