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 / automate common checks #4133

Open
13 tasks
timja opened this issue Oct 14, 2024 · 6 comments
Open
13 tasks

Document / automate common checks #4133

timja opened this issue Oct 14, 2024 · 6 comments

Comments

@timja
Copy link
Member

timja commented Oct 14, 2024

What feature do you want to see added?

These are some of the checks that have been recently noticed in hosting requests.
It would be good to either document or try and automate these checks, as I'm getting overwhelmed by the number of hosting requests...

  • Supports pipeline
  • Pipeline steps have a symbol
  • Pipeline function name follows conventions in ecosystem, camelCase, doesn't include step in the name, isn't too generic if plugin is non generic
  • Allowed license
  • src/main/resources/index.jelly has an appropriate description (avoids repeating plugin name and reads nicely as a description)
  • There should be no maintainers in pom.xml
  • README with relevant content
  • Proxy support if makes http calls
  • Proxy support uses Jenkins ProxyConfiguration class
  • Uses bom if it depends on Jenkins plugins
  • UI uses Jenkins controls, uses databinding and follows best practices from design library
  • Supports running on agents
  • Has a Jenkinsfile with sensible content
@timja
Copy link
Member Author

timja commented Oct 14, 2024

cc @mawinter69 / @NotMyFault / @alecharp if you've got any to add to the list.

@alecharp
Copy link
Contributor

I think checkin the Jenkinsfile and the src/main/resources/index.jelly, the usage of BOM if any dependencies are pretty solid.
Your list looks good to me for now (I cannot think of anything else).

@mawinter69
Copy link
Contributor

  • supports running on agents

@timja
Copy link
Member Author

timja commented Oct 14, 2024

thanks added both

@Brijeshthummar02
Copy link

Brijeshthummar02 commented Oct 18, 2024

@timja as there is no CONTRIBUTING.md file to the repository we should also add it.

Having this file in place would provide clear guidelines for new contributors on how to contribute effectively to the project, including steps for setting up the development environment, coding standards, and the process for submitting pull requests. This will help streamline the contribution process and encourage more participation.

@timja
Copy link
Member Author

timja commented Oct 18, 2024

Sure this issue is more dedicated to the checks for hosting requests not general contributions though.

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

4 participants