-
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
Changes from 5 commits
4bf7f9a
45eaa41
0b99b09
35aa82f
8f418e4
d1b9ad2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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). | ||
| --> | ||
| 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` | ||
| 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>). |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # How to contribute a toolkit | ||
|
|
||
| ## Submit your toolkit | ||
|
|
||
| To submit your toolkit, please open a pull request on the [Arcade Documentation GitHub repository](https://github.com/ArcadeAI/docs/) that uses the [Community Contributed Toolkit Pull Request Template](https://github.com/ArcadeAI/docs/blob/main/.github/PULL_REQUEST_TEMPLATE/community_contributed_toolkit.md). | ||
|
||
|
|
||
|
|
||
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