Skip to content

Commit bb09787

Browse files
committed
Contribution Guidelines: Add section about packageName metadata
1 parent 9354146 commit bb09787

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ Images should go into dedicated `images` folder:
3535
Use dash-case format for script files and directories, and use proper file extensions: Applescript should be `.applescript`, Swift should be `.swift`, Bash should be `.sh`, etc.
3636
Example: `spotify-next-track.applescript`
3737

38+
### `packageName` metadata
39+
40+
While `packageName` is an optional parameter and if it's missing Raycast will derive it from the directory name, it is required in this repository to improve portability. Make sure to always provide it in your script commands.
41+
3842
### Scripts that require additional modification
3943

4044
1. Ensure that comments include instructions on how to start using the script. E.g. you might need to provide API token, username or tweak parameters.

0 commit comments

Comments
 (0)