Skip to content

Add Running Tests section to README.adoc #45969

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

Closed
wants to merge 1 commit into from

Conversation

Rutujakolte03
Copy link
Contributor

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

  • Added helpful documentation for running tests.
  • Ensured formatting matches the rest of the README.

Thank you for reviewing this improvement!

image1

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!

Signed-off-by: Rutuja  <134671220+Rutujakolte03@users.noreply.github.com>
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jun 15, 2025
@snicoll
Copy link
Member

snicoll commented Jun 15, 2025

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?

@snicoll snicoll added the status: waiting-for-feedback We need additional information before we can continue label Jun 15, 2025
@Rutujakolte03
Copy link
Contributor Author

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!

@spring-projects-issues spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels Jun 18, 2025
@philwebb philwebb self-assigned this Jun 18, 2025
@philwebb philwebb added type: documentation A documentation update type: task A general task and removed status: waiting-for-triage An issue we've not yet triaged status: feedback-provided Feedback has been provided type: documentation A documentation update labels Jun 18, 2025
@philwebb philwebb added this to the 3.5.1 milestone Jun 18, 2025
philwebb pushed a commit that referenced this pull request Jun 18, 2025
Update the README to help potential contributors find information.

See gh-45969

Signed-off-by: Rutuja  <134671220+Rutujakolte03@users.noreply.github.com>
@philwebb philwebb closed this in 77877b4 Jun 18, 2025
@philwebb
Copy link
Member

Thanks @Rutujakolte03. I've taken the contributing section from the PR but dropped the testing section to remove duplication.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: task A general task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants