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.

Sign up for GitHub

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

Jump to bottom

IF plugin registry form proposal #2

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

IF plugin registry form proposal #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/if-plugin-registry-form-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: IF Plugin Registry Form template
about: Use this template to submit an IF plugin for registry
title: "[PLUGIN REGISTRY]"
labels: ''
assignees: ''

---

## Plugin Name
<!--- What is the plugin name? -->

## Link to Github/npm
<!--- please provide the url for your plugin's Github repository and/or npm package page -->

## Plugin Registry Basic Checklist
- [ ] My plugin integrates with IF, as demonstrated by execution from a manifest file with no errors or crashes.
- [ ] My plugin has README file.
pazbardanl marked this conversation as resolved.
Show resolved Hide resolved
- LINK: //link to readme here
- [ ] My plugin code includes a sample manifest .yaml file.
pazbardanl marked this conversation as resolved.
Show resolved Hide resolved
- LINK //paste link to your sample manifest here
- [ ] My plugin's code contain unit tests added to test its functionality.
- [ ] All unit tests that test my plugin are passing.
- [ ] I do not know of any security vulnerabilities associated with my code.
<!-- link out to any relevant disclosures, disclaimers or supporting info as necessary -->

## What does your plugin do?
<!--- Explain in a sentence or two what the plugin does. -->

## 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?

<!--- 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.

<!--- include both generic test cases (input validations, exception handling etc) as well as specific ones that have to do with the unique functionality and flow of your plugin -->