Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 760 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 760 Bytes
Raw

Contributing Guide

Thanks for wanting to contribute to bg-snippet 😁

We are open to all and any contributions. If you are going to undertake quite a large feature or refactor, maybe open an issue first to start a discussion with the maintainers.

Project Set Up

  1. Pull the repo and install the dependencies:

    git clone git@github.com:msafdev/bg-snippet.git

  2. Make your modifications / additions

  3. Update / Add Documentation

  4. Open pull request with overview off changes

Working with bg-snippet

All of the snippets are located in the components/common/background directory.

First compile all your changes made in the project:

bun run build

If successful, you can now open a pull request with your changes.