Skip to content

Commit

Permalink
Docs: Add Contributing to an Extension page. (raycast#903)
Browse files Browse the repository at this point in the history
  • Loading branch information
sxn authored Feb 14, 2022
1 parent de0735d commit c92429d
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 13 deletions.
5 changes: 4 additions & 1 deletion .gitbook.yaml
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
root: ./docs/
root: ./docs/

redirects:
basics/import-an-extension: basics/contribute-to-an-extension.md
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# How to Contribute

🎉 First of all, thanks for taking the time to contribute! 🎉

- If you want to create a new extension, follow the [Create Your First Extension](https://developers.raycast.com/basics/create-your-first-extension) guide.
- If you want to contribute to an existing extension, follow the [Contribute to an Extension](https://developers.raycast.com/basics/contribute-to-an-extension) guide.

We're still figuring things out and updating our guidelines. If at any point something is unclear, please tell us in [our community](https://raycast.com/community).
Binary file removed docs/.gitbook/assets/basics-import-extension.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@

- [Getting Started](basics/getting-started.md)
- [Create Your First Extension](basics/create-your-first-extension.md)
- [Contribute to an Extension](basics/contribute-to-an-extension.md)
- [Prepare an Extension for Store](basics/prepare-an-extension-for-store.md)
- [Publish an Extension](basics/publish-an-extension.md)
- [Debug an Extension](basics/debug-an-extension.md)
- [Install an Extension](basics/install-an-extension.md)
- [Import an Extension](basics/import-an-extension.md)

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
description: Learn how to import an extension to collaborate with others.
---

# Import an Extension
# Contribute to an Extension

All published extensions are open source and can be found in [this repository](https://github.com/raycast/extensions). This makes it easy for multiple developers to collaborate. This guide explains how to import an extension to develop on it.
All published extensions are open source and can be found in [this repository](https://github.com/raycast/extensions). This makes it easy for multiple developers to collaborate. This guide explains how to import an extension in order to fix a bug, add a new feature or otherwise contribute to it.

### Get source code

Expand All @@ -14,16 +14,10 @@ First, you need to find the source code of the extension. The easiest way to do

Then, you need to [clone our repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) to have the source code locally.

### Import the extension

After you cloned the repository, open the Import Extension command and select the folder of the extension that you want to import. For this guide, we add the [API Examples](https://github.com/raycast/extensions/tree/main/examples/api-examples) extension.

![Import an extension](../.gitbook/assets/basics-import-extension.png)

### Develop the extension

Continue to the Manage Extensions command, select the imported extension, and press `` to open it in your default text editor. Then run `npm install && npm run dev` from the extension folder in your Terminal to start developing the extension.
After you've cloned the repository, open the Terminal and navigate to the extension's folder. For this guide, we are modifying the [API Examples](https://github.com/raycast/extensions/tree/main/examples/api-examples) extension. Once there, run `npm install && npm run dev` from the extension folder in your Terminal to start developing the extension.

![Open imported extension](../.gitbook/assets/basics-open-command.png) ![Icon list command](../.gitbook/assets/basics-icon-list.png)

You should see your imported extension at the top of your root search and can open its commands. When you're done remixing the extension, submit a pull request to [publish your changes to the store](publish-an-extension.md).
You should see your imported extension at the top of your root search and can open its commands. When you're done remixing the extension, make sure to add yourself to the contributors section of its [manifest](./../information/manifest.md##extension-properties), then submit a pull request to [publish your changes to the store](publish-an-extension.md).
2 changes: 1 addition & 1 deletion docs/basics/publish-an-extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To share your extension with others, you need to open a pull request in our [rep
After you opened a pull request, we'll review your extension and request changes when required. Once accepted, the pull request is merged and your extension will be automatically published to the [Raycast Store](https://raycast.com/store).

{% hint style="info" %}
We're still figuring things out and update our guidelines. If something is unclear, please tell us in [our community](https://raycast.com/community).
We're still figuring things out and updating our guidelines. If something is unclear, please tell us in [our community](https://raycast.com/community).
{% endhint %}

### Share your extension
Expand Down

0 comments on commit c92429d

Please sign in to comment.