Skip to content

Commit e20fe8d

Browse files
committed
Add Publishing to the Community Repository section
1 parent ba52b20 commit e20fe8d

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

blog/2024-11-11-package.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,26 @@ The `Lingo.toml` can also include additional sections for dependencies and other
116116

117117
## Publishing to the Community Repository
118118

119-
TBD
119+
Once you've created your package and configured the `Lingo.toml` file, you’re ready to publish it in the [Lingua Franca Packages](https://github.com/lf-pkgs) organization. Publishing your package here allows other developers to easily find, install, and use it in their projects.
120+
121+
To publish your package, follow these steps:
122+
123+
1. **Push your package to your GitHub repository**
124+
Uploading your package to GitHub lets you share it with others right away, even before it becomes part of the organization.
125+
126+
2. **Name your repository following the `<name>-<target>` scheme**
127+
Use lowercase letters and hyphens in the format `<name>-<target>` (e.g., `package-python`). The `<name>` part should be descriptive and unique, while the `<target>` should be the target language for the package.
128+
129+
3. **Include the name of the current maintainer in the repository description.**
130+
This helps others know who to contact if they have questions or need assistance.
131+
132+
3. **Request membership in the Lingua Franca Packages organization**
133+
To join the organization, reach out to the Lingua Franca Packages [owners](https://github.com/orgs/lf-pkgs/people) with a brief overview of your package. This message should include:
134+
- **Motivations**: Describe why you created the package and what problems it solves.
135+
- **Usage**: Outline how others can use the package, highlighting key features or functionalities.
136+
- **Relevant Links**: Include a link to the repository (essential) along with any other resources, such as documentation, demos, or example projects that showcase the package in action.
137+
138+
This information will help the organization understand the value of your package and how it contributes to the Lingua Franca community.
139+
140+
4. **Transfer your repository to the Lingua Franca Packages organization**
141+
Once you're a member, transfer your repository to the organization to make it available to the broader community.

0 commit comments

Comments
 (0)