CONTRIBUTING.md

Setting up the environment

This repository uses pnpm. Other package managers may work but are not officially supported for development.

To set up the repository, run:

$ pnpm install
$ pnpm build

This will install all the required dependencies and build output files to dist/.

Contribution Requirements

Follow the shared Xquik contribution policy.

Submit non-trivial changes through pull requests.

A person other than the author must approve each non-trivial change.

Sign every commit using the Developer Certificate of Origin:

git commit -s

Start with issues labeled good first issue when seeking a small task.

Modifying/Adding code

Most of the SDK is generated code. Modifications to code will be persisted between generations, but may result in merge conflicts between manual patches and changes from the generator. The generator will never modify the contents of the src/lib/ and examples/ directories.

Adding and running examples

All files in the examples/ directory are not modified by the generator and can be freely edited or added to.

// add an example to examples/<your-example>.ts

#!/usr/bin/env -S npm run tsn -T
…

$ chmod +x examples/<your-example>.ts
# run the example against your api
$ pnpm tsn -T examples/<your-example>.ts

Using the repository from source

If you’d like to use the repository from source, you can either install from git or link to a cloned repository:

To install via git:

$ npm install git+ssh://git@github.com:Xquik-dev/x-twitter-scraper-typescript.git

Alternatively, to link a local copy of the repo:

# Clone
$ git clone https://www.github.com/Xquik-dev/x-twitter-scraper-typescript
$ cd x-twitter-scraper-typescript

# With yarn
$ yarn link
$ cd ../my-package
$ yarn link x-twitter-scraper

# With pnpm
$ pnpm link --global
$ cd ../my-package
$ pnpm link --global x-twitter-scraper

Running tests

$ pnpm run test

Tests enforce at least 90% statement coverage.

Tests enforce at least 80% branch coverage.

Add regression tests for every corrected defect.

Run the reproducibility check before requesting review:

$ pnpm run check:reproducible

Linting and formatting

This repository uses prettier and eslint to format the code in the repository.

To lint:

$ pnpm lint

To format and fix all lint issues automatically:

$ pnpm fix

Publishing and releases

Changes made through the automated release pipeline publish to npm automatically.

Publish with a GitHub workflow

The Publish npm workflow validates release tags, builds the package, signs its provenance, uploads release assets, and publishes through npm trusted publishing. The release path uses short-lived identity tokens. It stores no npm token.

Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.