Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 2.2 KB
Raw

Contributing to Supabase Pause Prevention

Thanks for considering contributing to the Supabase Pause Prevention project! Your help is essential for keeping the project up-to-date and running smoothly. Below are some guidelines to follow when contributing.

Getting Started

  1. Fork the repository: Click the "Fork" button at the top of this page to create a copy of the repository under your GitHub account.

  2. Clone your fork: Clone your forked repository to your local machine using the following command:

    git clone https://github.com/travisvn/supabase-pause-prevention.git

  3. Install dependencies: Navigate into the project folder and install any necessary dependencies:

    cd supabase-pause-prevention
npm install

  4. Create a new branch: Before making changes, create a new branch for your work:

    git checkout -b your-branch-name

Making Changes

  1. Code standards: Ensure your code follows any existing styles and conventions used in the project. This includes proper formatting, variable naming, and comments where necessary.

  2. Testing: Run the available tests to ensure your changes don't break existing functionality:

    npm test

    If new functionality is added, please add relevant tests as well.

  3. Commit your changes: After you've made your changes, commit them with a clear and concise message:

    git add .
git commit -m "Brief description of your changes"

  4. Push to your branch: Push the changes to your fork:

    git push origin your-branch-name

Submitting a Pull Request

  1. Once you're happy with your changes, go to the original repository on GitHub and submit a pull request. In your PR description, explain what changes you've made and any additional context.

  2. The project maintainers will review your pull request and may ask for changes. Once everything is in order, your pull request will be merged into the main branch.

Reporting Issues

If you find a bug or have a feature request, please open an issue and provide as much detail as possible.

Thank you for your contributions!