Thank you for contributing to the CF CLI Plugin Repository!
This repo contains both the plugin repo server and the metadata for CLI
community plugins.
Some of the requirements for PRs will apply to only one of these parts.
We're not allowed to accept any PRs without a signed CLA, no matter how small.
If your contribution falls under a company CLA but your membership is not public, expect delays while we confirm.
In particular ensure the following requirements are being met:
[x] The plugin's name field in repo-index.yml matches the Name field in the plugin's plugin.PluginMetadata section
[x] The plugin's url field in repo-index.yml contains the same version from the version field
Submitting PRs to CLIPR (the CLI Plugin Repo server)
All new code requires tests to protect against regressions.
Description of the Change
We must be able to understand the design of your change from this description.
Keep in mind that the maintainer reviewing this PR may not be familiar with or
have worked with the code here recently, so please walk us through the concepts.
Why Is This PR Valuable?
What benefits will be realized by the code change? What users would want this change? What user need is this change addressing?
Applicable Issues
List any applicable Github Issues here
How Urgent Is The Change?
Is the change urgent? If so, explain why it is time-sensitive.
Thank you for contributing to the CF CLI Plugin Repository!
This repo contains both the plugin repo server and the metadata for CLI community plugins. Some of the requirements for PRs will apply to only one of these parts.
We're not allowed to accept any PRs without a signed CLA, no matter how small. If your contribution falls under a company CLA but your membership is not public, expect delays while we confirm.
Submitting Plugins
If you haven't yet, please review our contributing guidelines:
https://github.com/cloudfoundry/cli-plugin-repo#submitting-plugins
In particular ensure the following requirements are being met:
name
field inrepo-index.yml
matches theName
field in the plugin'splugin.PluginMetadata
sectionurl
field inrepo-index.yml
contains the same version from theversion
fieldSubmitting PRs to CLIPR (the CLI Plugin Repo server)
All new code requires tests to protect against regressions.
Description of the Change
We must be able to understand the design of your change from this description. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
Why Is This PR Valuable?
What benefits will be realized by the code change? What users would want this change? What user need is this change addressing?
Applicable Issues
List any applicable Github Issues here
How Urgent Is The Change?
Is the change urgent? If so, explain why it is time-sensitive.
Other Relevant Parties
Who else is affected by the change?