microsoft / microsoft/copilot-camp

[E2] Provide information on how to create an API plugin

Open
#202 2 comments 0 reactions 2 assignees View on GitHub

@rabwill is already working on this.

Since Nov 26, 2024.

documentation
Dominant language
C#
Stars
664
Forks
175
Avg merge
1m
Merged PRs (30d)
7

Description

I appreciate that the lab gives you a starting point so that you don't have to deal with lot of boilerplate JSON but, as someone who is approaching API plugins for the first time, I find it a bit confusing because, once I have completed the lab, I have no idea on how to create a new one on my own.

I think it would be beneficial to:

  • Keep the copy & paste approach but, in the intro of the exercise, add a paragraph that explains how you have created the plugin definition

OR

  • Let the user create the plugin given the API URL and then replace the generated content with the one provided in the starting project.

The second one would be more effective, but I understand it's more challenging because the API URL isn't fixed and, in the plugin definition, it's defined with a variable.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.