Skip to content

Commit c92429d

Browse files
authored
Docs: Add Contributing to an Extension page. (raycast#903)
1 parent de0735d commit c92429d

6 files changed

+18
-13
lines changed

.gitbook.yaml

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
root: ./docs/
1+
root: ./docs/
2+
3+
redirects:
4+
basics/import-an-extension: basics/contribute-to-an-extension.md

CONTRIBUTING.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# How to Contribute
2+
3+
🎉 First of all, thanks for taking the time to contribute! 🎉
4+
5+
- If you want to create a new extension, follow the [Create Your First Extension](https://developers.raycast.com/basics/create-your-first-extension) guide.
6+
- 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.
7+
8+
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).
-353 KB
Binary file not shown.

docs/SUMMARY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@
1313

1414
- [Getting Started](basics/getting-started.md)
1515
- [Create Your First Extension](basics/create-your-first-extension.md)
16+
- [Contribute to an Extension](basics/contribute-to-an-extension.md)
1617
- [Prepare an Extension for Store](basics/prepare-an-extension-for-store.md)
1718
- [Publish an Extension](basics/publish-an-extension.md)
1819
- [Debug an Extension](basics/debug-an-extension.md)
1920
- [Install an Extension](basics/install-an-extension.md)
20-
- [Import an Extension](basics/import-an-extension.md)
2121

2222
## Examples
2323

docs/basics/import-an-extension.md docs/basics/contribute-to-an-extension.md

+4-10
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
description: Learn how to import an extension to collaborate with others.
33
---
44

5-
# Import an Extension
5+
# Contribute to an Extension
66

7-
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.
7+
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.
88

99
### Get source code
1010

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

1515
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.
1616

17-
### Import the extension
18-
19-
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.
20-
21-
![Import an extension](../.gitbook/assets/basics-import-extension.png)
22-
2317
### Develop the extension
2418

25-
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.
19+
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.
2620

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

29-
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).
23+
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).

docs/basics/publish-an-extension.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To share your extension with others, you need to open a pull request in our [rep
2323
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).
2424

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

2929
### Share your extension

0 commit comments

Comments
 (0)