-
Notifications
You must be signed in to change notification settings - Fork 7
How to add your own toolkit #173
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4bf7f9a
Add Obsidian
EricGustin 45eaa41
Better formatting
EricGustin 0b99b09
Link to github repos
EricGustin 35aa82f
Add instructions on how to add your own toolkit
EricGustin 8f418e4
Dont include obsidian and memory toolkits in this PR
EricGustin d1b9ad2
Improve 'how to contribute a toolkit' docs
EricGustin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| <!-- | ||
| Before submitting a pull request, please read: | ||
|
|
||
| For contributing a community toolkit, please use the [Community Contributed Toolkit Pull Request Template](https://github.com/ArcadeAI/docs/blob/main/.github/PULL_REQUEST_TEMPLATE/community_contributed_toolkit.md). | ||
| --> | ||
16 changes: 16 additions & 0 deletions
16
.github/PULL_REQUEST_TEMPLATE/community_contributed_toolkit.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| ## Add community toolkit "your-toolkit-name" | ||
|
|
||
| ## Toolkit Checklist | ||
|
|
||
| - [ ] The toolkit is published to PyPI | ||
| - [ ] The toolkit source code is hosted in a publicly accessible repository on a supported version control platform (e.g., GitHub, GitLab, etc.) | ||
| - [ ] The toolkit is licensed under an open source license | ||
|
|
||
| ## PR Checklist | ||
|
|
||
| - [ ] I have determined the appropriate category for the toolkit, e.g., `productivity`, `social-communication`, `entertainment`, `development`, `automation`, etc. | ||
| - [ ] I create a new file located at `pages/toolkits/<category>/my-toolkit-name.mdx` that uses the [Community Toolkit Template](https://github.com/ArcadeAI/docs/blob/main/pages/toolkits/community-toolkit-template.mdx) | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this link will work once this PR is merged since we are adding that file in this PR |
||
| - [ ] I have added the toolkit to the `pages/toolkits/<category>/_meta.ts` file | ||
| - [ ] I have added the toolkit to the `src/components/custom/Toolkits/toolkits-config.ts` file. For the toolkit's image, | ||
| - [ ] I am using the default image `public/images/icons/community-contributed.png` OR | ||
| - [ ] I am using an image that is smaller than 5 KB that I have added at `public/images/icons/<image-name>.png` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Arcade <toolkit-name> Toolkit | ||
|
|
||
| The Arcade <toolkit-name> Toolkit is a community contributed toolkit meaning that it is created and maintained by the community. To learn more about the toolkit, please visit the [Arcade <toolkit-name> GitHub repository](https://github.com/<github-username>/<repo-name>). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # How to contribute a toolkit | ||
|
|
||
| Arcade welcomes your toolkit contributions. By adding your toolkit to the Arcade documentation, you help other developers discover and use your tools. Follow these steps to submit your own toolkit. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Build your toolkit. See [build a toolkit](home/build-tools/create-a-toolkit) for guidance. | ||
| - Publish your toolkit on PyPI. | ||
|
|
||
| ## Submit your toolkit | ||
| Open a pull request in the [Arcade Documentation GitHub repository](https://github.com/ArcadeAI/docs) that completes the [community toolkit checklist](https://github.com/ArcadeAI/docs/blob/main/.github/PULL_REQUEST_TEMPLATE/community_contributed_toolkit.md). The checklist will guide you through the necessary steps to ensure your toolkit contribution is successful. | ||
|
|
||
| ## Review and merge | ||
|
|
||
| After submitting your pull request: | ||
| - Double-check all checklist items have been completed. | ||
| - Address any feedback from the reviewers. | ||
| - Once approved, your toolkit will be added to the Arcade documentation for other developers to discover and use! |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
whenever someone opens a PR in the docs repo, this will be in the PR description