Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1015 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (15 loc) · 1015 Bytes

Contributing to Logestic

Reporting Issues

😥 Feel free to submit an issue when Logestic is not working as you expected.

Solving Issues

  1. ❗ All PRs must reference an issue.
  2. 🗣 If there is an issue you want to work on, ask on the issue thread if you want to work on it.
  3. 🍴 Fork this repository and create a new branch fix-[number]/[short description] according to the issue.
  4. ✍ Fix the issue.
  5. 🎆 Open a PR and wait until a collaborator merges it in.

Adding Presets

  1. 🍴 Fork this repository and create a new branch preset-[name] with the name of your preset.
  2. ✍ Create a new file under presets/ and export an Elysia instance with your Logestic middleware.
  3. ➕ Add the case clause file in index.ts and the key type to types.
  4. 🖼 Add a preview screenshot in screenshots.
  5. 🎆 Open a PR and wait until a collaborator merges it in. Attach a screenshot so we can add to the Wiki.