spring-projects
Add Running Tests section to README.adoc
Summary
This pull request adds a new "Running Tests" section to the README.adoc file.
The goal is to help new contributors and users understand how to run the full test suite before submitting changes.
Motivation
- The README previously described how to build the project, but did not explicitly mention how to run the tests.
- Running the test suite is essential to ensure stability and maintain code quality, especially before submitting a pull request.
- This addition makes the contribution process clearer and more accessible, especially for first-time contributors.
Details of the Change
- Added a "Running Tests" section after "Building from Source" and before "Modules".
- Provides a simple Gradle command (
./gradlew test) for running all tests. - Reminds contributors to review and address any test failures before submitting a PR.
Checklist
- [x] Added helpful documentation for running tests.
- [x] Ensured formatting matches the rest of the README.
Thank you for reviewing this improvement!
Thanks for the PR but aren't these already explained in https://github.com/spring-projects/spring-boot/blob/main/CONTRIBUTING.adoc#code-conventions-and-housekeeping? Running tests with Spring Boot is no different from any Gradle project. However, our project has additional checks (checkstyle, code formatting) that are worth explaining and that's done in the document I've referenced. Thoughts?
Thanks for the PR but aren't these already explained in https://github.com/spring-projects/spring-boot/blob/main/CONTRIBUTING.adoc#code-conventions-and-housekeeping? Running tests with Spring Boot is no different from any Gradle project. However, our project has additional checks (checkstyle, code formatting) that are worth explaining and that's done in the document I've referenced. Thoughts?
Thank you for the feedback! You're right, the CONTRIBUTING.adoc does cover running tests and also mentions the additional checks like checkstyle and code formatting.
My intention with adding the "Running Tests" section to the README was to make it easier for new contributors to quickly find this information, since README is often the first place people look. However, I understand the concern about duplication and maintaining a single source of truth.
Would you prefer if I added a link in the README pointing to the relevant section in CONTRIBUTING.adoc, rather than repeating the details? Let me know what you think!
Thanks @Rutujakolte03. I've taken the contributing section from the PR but dropped the testing section to remove duplication.
It seems that the title needs to be updated to reflect the changes made in this PR.
