Skip to content
This repository was archived by the owner on Apr 7, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (20 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.53 KB

Contributions

I'm glad you're reading this because it means you're interested in contributing to this project. We need developers who help this project grow 🌱!

Here are some important resources:

  • Repository holds the code and content of the zap package
  • GitHub Issues indicates everything you can work on (of course, you are free to propose anything else 😉)
  • Discussions is where we talk about the package features and future
  • Releases represents the present and history of this package project

How to contribute

Contributing to this project is straightforward:

  1. Fork the repository on your own profile and start coding
  2. When you're finished, update the documentation under the docs folder if necessary
  3. Push your commits to your own repository
  4. Open a Pull Request to the main repository branch

And you're done!

Guidelines

Warning

These guidelines are here to help keep this project well-organized and easy to manage for me.

  1. Before submission, please execute typstyle -l 180 -t 4 -i src to get your code clean
  2. One Pull Request means one feature/component
  3. Communication is necessary, please give your Pull Request a short, descriptive title with a quick explanation of the feature you developed. PR names should start with feat, feat(component), docs, chore, ... for example feat: adding voltage decorations to components
⚡