Contributing

March 15, 2022 ยท View on GitHub

๐Ÿ‘๐ŸŽ‰ First off, thanks for taking the time to contribute! ๐ŸŽ‰๐Ÿ‘

If you have found an issue or would like to request a new feature, simply create a new issue detailing the request. We also welcome pull requests. See below for information on getting started with development and submitting pull requests.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better you can submit a Pull Request with a fix.

Submitting a Pull Request

  • If applicable, update the readme

  • Use npm run lint and npm run prettier before committing

  • Example for a commit message

    Fix type validation for typescript
    

Developing

Fork, then clone the repo:

git clone https://github.com/your-username/reactive-button.git
cd reactive-button

Install dependencies:

npm install

Building

Running the build task will create the dist version of the project.

npm run build

Project Structure

root
โ”œโ”€โ”€ dist
โ””โ”€โ”€ src
    โ””โ”€โ”€ css
โ””โ”€โ”€ types