diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..18772d67d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ + diff --git a/.github/PULL_REQUEST_TEMPLATE/community_contributed_toolkit.md b/.github/PULL_REQUEST_TEMPLATE/community_contributed_toolkit.md new file mode 100644 index 000000000..0cc4900c3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/community_contributed_toolkit.md @@ -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//my-toolkit-name.mdx` that uses the [Community Toolkit Template](https://github.com/ArcadeAI/docs/blob/main/pages/toolkits/community-toolkit-template.mdx) +- [ ] I have added the toolkit to the `pages/toolkits//_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/.png` diff --git a/pages/toolkits/_meta.ts b/pages/toolkits/_meta.ts index acab04406..e99197b14 100644 --- a/pages/toolkits/_meta.ts +++ b/pages/toolkits/_meta.ts @@ -5,6 +5,10 @@ export default { layout: "full", }, }, + "-- Categories": { + type: "separator", + title: "Categories", + }, productivity: { title: "Productivity & Docs", }, @@ -20,4 +24,14 @@ export default { automation: { title: "Automation", }, + "-- Submit your toolkit": { + type: "separator", + title: "Submit your toolkit", + }, + "contribute-a-toolkit": { + title: "Contribute a toolkit", + }, + "community-toolkit-template": { + display: "hidden", + }, }; diff --git a/pages/toolkits/community-toolkit-template.mdx b/pages/toolkits/community-toolkit-template.mdx new file mode 100644 index 000000000..a1cd4b208 --- /dev/null +++ b/pages/toolkits/community-toolkit-template.mdx @@ -0,0 +1,3 @@ +# Arcade Toolkit + +The Arcade 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 GitHub repository](https://github.com//). diff --git a/pages/toolkits/contribute-a-toolkit.mdx b/pages/toolkits/contribute-a-toolkit.mdx new file mode 100644 index 000000000..08c169ffc --- /dev/null +++ b/pages/toolkits/contribute-a-toolkit.mdx @@ -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!