Contributing

First off, thanks for taking the time to contribute 🎉!

• Setup
• Develop
• Pull Request
• Contributing Guidelines

Setup

Before you do anything, you need to setup a development environment. If you haven't used Git before, I'd highly recommend reading Pro Git (it's 100% free and open source)

1. Fork this repository

   • What is a fork?
   • Fork Schooltape

2. Clone your fork

   • Make sure you have Git installed
   • What is cloning?
   • Clone Schooltape

   cd /path/to/your/working/directory
   git clone https://github.com/your_username/schooltape
   cd schooltape

3. Install Bun

   Linux

   curl -fsSL https://bun.sh/install | bash

   MacOS

   curl -fsSL https://bun.sh/install | bash

   Windows

   powershell -c "irm bun.sh/install.ps1 | iex"

4. Install dependencies

   bun install

5. Build the extension

   Chrome

   bun dev

   Firefox

   bun dev:firefox

Develop

1. Open an issue describing your change to get your idea approved

2. Please read the specific guides on how to contribute your own:

   • Plugins
   • Themes
   • Snippets

3. Then, how you can submit a pull request to get your changes implemented!

Pull Request

To merge your changes into this repository you can create a pull request (PR).

Here is a handy guide on what a pull request is and how to make one.

Contributing Guidelines

Finally, and importantly, please ensure to follow the styling and contributing guidelines outlined here.