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

IF plugin registry form proposal #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pazbardanl
Copy link

Proposing an issue template for registering an IF plugin to the registry website

@pazbardanl pazbardanl requested a review from jmcook1186 May 9, 2024 10:08
## Define, in your own words, what is(are) the Requirement(s) of your plugin
<!--- I.E what is the basic functionality it must demonstrate. -->

## Please provide citations, links and references that support the validity of the implementation of your plugin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's actually deal with this by suggesting best practises in the registry docs instead of requiring it here

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we wanted to have this (and other answers) in this form so that:

  1. Other ppl in the community can review any registered plugin at any time (transparency)
  2. We can later review and revisit when we start randomly auditing plugins.
    I don't mind citations, links and references being kept somewhere else, but I do think there should be only 1 place for all basic info for each register plugin. WDYT?

## Please provide citations, links and references that support the validity of the implementation of your plugin
<!--- I.E provide reference to sources explaining how this implementation meets the requirement described above. -->

## Please describe the test cases covered by your plugin's dedicated unit tests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Please describe the test cases covered by your plugin's dedicated unit tests

Again, let's handle this elsewhere

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again, I don't mind. just think we need 1 place where all info (that is - the answers to the questions in this form) for all registered plugins reside in.

Copy link
Contributor

@jmcook1186 jmcook1186 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi - left some suggestions. Thinking on this some more, it's best to keep this minimal and have the more detailed guidance coming in the submission guideline docs.

@pazbardanl pazbardanl force-pushed the plugin-registry-form-proposal branch 2 times, most recently from c7a2403 to f1fb61a Compare May 16, 2024 10:28
…istering an IF plugin to the registry website

Signed-off-by: Paz Barda <paz.barda@intel.com>
@pazbardanl pazbardanl force-pushed the plugin-registry-form-proposal branch from f1fb61a to 799501b Compare May 16, 2024 10:30
@pazbardanl
Copy link
Author

Hi - left some suggestions. Thinking on this some more, it's best to keep this minimal and have the more detailed guidance coming in the submission guideline docs.

Made most of the changes requested, please see my comments on last 2. thanks.

@jmcook1186
Copy link
Contributor

approving this but also flagging that the website team decided to move this form to a Notion NoteForm form that can auto-populate a db for the website to pull from

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

Successfully merging this pull request may close these issues.

None yet

2 participants