CONTRIBUTING.md

Contributing to SyncLinear.com

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

• Before jumping into a PR be sure to search existing PRs or issues for an open or closed item that relates to your submission.

Developing

The development branch is main. This is the branch that all pull requests should be made against. The changes on the main branch are tagged into a release monthly.

To develop locally:

1. Fork this repository to your own GitHub account and then clone it to your local device.

2. Create a new branch:

   git checkout -b MY_BRANCH_NAME

3. Install the dependencies:

   pnpm install

4. Start developing and watch for code changes:

   pnpm dev

Building

You can build the project with:

pnpm build

Please be sure that you can make a full production build before pushing code.

Testing

More info on how to add new tests coming soon.

Linting

To check the formatting of your code:

pnpm lint

If you get errors, be sure to fix them before committing.

Making a Pull Request

• Be sure to check the "Allow edits from maintainers" option while creating you PR.
• If your PR refers to or fixes an issue, be sure to add refs #XXX or fixes #XXX to the PR description. Replacing XXX with the respective issue number. Se more about Linking a pull request to an issue .
• Be sure to fill the PR Template accordingly.

Architecture

This app has two major components: a "webhook consumer" and a web UI for auth.

The webhook consumer is a single endpoint that receives webhooks from Linear and GitHub then decides what to do.

Data such as GitHub repos, synced issues, and usernames are persisted in PostgreSQL. This is the current data model, as specified in the schema: