Skip to content

Commit

Permalink
Update blog/2024-11-11-package.md
Browse files Browse the repository at this point in the history
Co-authored-by: Edward A. Lee <[email protected]>
  • Loading branch information
vinzbarbuto and edwardalee authored Jan 3, 2025
1 parent 715a3fd commit cfb4d61
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions blog/2024-11-11-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ When creating a new package, ensure that you follow these guidelines:

- **README.md**: Include a `README.md` file in the root directory. This should provide an overview of the package, its purpose, a description of the LF files in the `lib/` folder, and relevant user information. The `README.md` is essential for publishing your package to the community repository and must be kept up to date.

- **LICENSE**: A text file giving the license terms for the package.
- **File Naming**: Use descriptive names for files in the `lib/` directory that reflect their purpose. For example, name a file containing a reactor for different sensors as `Sensor.lf`.

- **Example LF Files**: Include example LF files in the `src/` directory to demonstrate how to use the reactors in the `lib/` directory. These examples should be well-documented with comments explaining the purpose and usage of each reactor.
Expand Down

0 comments on commit cfb4d61

Please sign in to comment.