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

Commenting Test Files #7332

Closed
WillCoHill opened this issue May 25, 2024 · 1 comment
Closed

Commenting Test Files #7332

WillCoHill opened this issue May 25, 2024 · 1 comment

Comments

@WillCoHill
Copy link

Suggestion

As a Jenkins user, I want to add comments to the code in various testing files.
For my Open Source class, I especially paid attention to those files in the test/src/test/java/jenkins directory and felt that some files could benefit from commenting on the @tests to clarify both the test's purpose and parameter details if applicable for posterity.

Links

https://github.com/jenkinsci/jenkins/blob/master/test/src/test/java/jenkins/telemetry/TelemetryTest.java

Are you interested in contributing to this improvement?

Yes, I would be interested on contributing to this improvement, given the okay to do so.

@MarkEWaite
Copy link
Contributor

Thanks for your interest @WillCoHill . You are welcome to submit descriptions of tests as comments in the test source files of the Jenkins core repository.

I'm closing this issue because we use the issue tracker in this repository to track issues with the www.jenkins.io site, not with Jenkins core.

@MarkEWaite MarkEWaite closed this as not planned Won't fix, can't repro, duplicate, stale Jun 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants