Skip to content

Contributing to social-connector

Contributions to social-connector are greatly appreciated! You are welcome to file bug reports, suggest new features, fix bugs and add a feature. Also improving the documentation is a good way to start. If you are not sure whether your idea makes sense as part of this package goal, begin a conversation.

Filing bug reports

Bug reports should be filed using GitHub's Issue Tracker. Please add a minimal reproduction and/or instructions for reproducing the bug.

Suggesting new features

Feature suggestions should be filed using GitHub's Issue Tracker. Please add a detailed description of the feature and the use case.

Setting up your development environment

  1. Fork this repository.

  2. Clone the forked repo to your local machine.

  3. Run npm install inside the root folder.

  4. If you are developing the library, add the following environment variables:

    shell
    VITE_IG_APP_ID="YOUR_INSTAGRAM_APP_ID";
    VITE_IG_REDIRECT_URI="https://YOUR_REDIRECT_URI/";
  5. You can now run either npm run dev or npm run docs:dev, depending on if you are developing the library or the documentation.

  6. Develop!