Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document How to Configure Spring Security in Eclipse, IntelliJ, and VSCode #11157

Open
Tracked by #12916
marcusdacoregio opened this issue Apr 20, 2022 · 3 comments
Open
Tracked by #12916
Labels
in: docs An issue in Documentation or samples type: enhancement A general enhancement
Milestone

Comments

@marcusdacoregio
Copy link
Contributor

Some users are having a hard time configuring their environment to work with the Spring Security codebase.

We should review and improve the CONTRIBUTING doc in order to avoid contributors wasting time with stuff like formatting, imports, etc.

See:

@marcusdacoregio marcusdacoregio added in: docs An issue in Documentation or samples type: enhancement A general enhancement labels Apr 20, 2022
@marcusdacoregio marcusdacoregio self-assigned this Apr 20, 2022
@marcusdacoregio
Copy link
Contributor Author

The import order is not fixed automatically, we should provide the IDE configuration or at least mention what is the expected import order:

import java.*
<blank line>
import javax.*
<blank line>
import jakarta.*
import all other imports
<blank line>
import org.springframework.*
<blank line>
import static all other imports

@marcusdacoregio marcusdacoregio modified the milestones: 5.8, 5.8.x Jun 7, 2022
@rwinch rwinch removed this from the 5.8.x milestone Jun 13, 2022
@marcusdacoregio marcusdacoregio added this to the 5.8.x milestone Jun 22, 2022
@marcusdacoregio marcusdacoregio removed this from the 5.8.x milestone Jun 22, 2022
@marcusdacoregio marcusdacoregio added this to the 5.8.0-M2 milestone Jul 27, 2022
@rwinch rwinch modified the milestones: 5.8.0-M2, 5.8.0-M3 Aug 12, 2022
@sjohnr sjohnr modified the milestones: 5.8.0-M3, 5.8.0-RC1 Sep 16, 2022
@sjohnr sjohnr modified the milestones: 5.8.0-RC1, 5.8.x Oct 18, 2022
@marcusdacoregio marcusdacoregio removed their assignment Jan 17, 2023
@jzheaux
Copy link
Contributor

jzheaux commented Mar 28, 2023

I think setting up the dev environment should go in a separate document. The reason is that it branches out based on your IDE and perhaps your OS. I think Spring Framework's Build from Source document could be a guide.

@jzheaux jzheaux changed the title Improve CONTRIBUTING doc Document How to Configure Spring Security in Eclipse, IntelliJ, and VSCode Mar 28, 2023
@Crain-32
Copy link
Contributor

Crain-32 commented Apr 5, 2024

As I just experienced the horrors of getting the formatting correct, I'd like to say it appears IntelliJ now supports the necessary import configurations.

For development environments Spring as a whole could provide simple dev containers or devfiles with the expected tools (Gradle, JVM Versions, etc) to contribute. (I will admit I haven't reviewed if other issues have covered this topic previously)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: docs An issue in Documentation or samples type: enhancement A general enhancement
Projects
None yet
Development

No branches or pull requests

5 participants