Skip to content

Add AGENTS guide #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joaomantovani merged 1 commit into from
Jul 11, 2025
Merged

Add AGENTS guide #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Repository Guide

## Overview
This repository contains a React Native library (`reactnative-forceupdate`) and an example application under the `example/` folder. The library source code lives in `src/` and unit tests are in `src/__tests__/`. The project uses Yarn workspaces and requires Node.js 18.

## Development
- Install dependencies with `yarn` from the repository root. Do **not** use `npm`.
- Run the following before committing any change:
- `yarn lint` – ESLint with Prettier rules
- `yarn typecheck` – TypeScript compilation without emitting files
- `yarn test` – Jest unit tests
- Pre‑commit hooks run ESLint and TypeScript checks (see `lefthook.yml`). Commit messages must follow the [Conventional Commits](https://www.conventionalcommits.org/) specification.
- The example application can be run with `yarn example <platform>` where `<platform>` is `start`, `android`, `ios` or `web`.

## Building and Publishing
- Build the library with `yarn prepare` (uses `react-native-builder-bob`).
- Releases are handled via `yarn release` which uses `release-it`.

## Continuous Integration
GitHub Actions (`.github/workflows/ci.yml`) run `yarn lint`, `yarn typecheck`, `yarn test` with coverage, build the library and the web example.

## Pull Requests
Keep pull requests focused and small. Verify that lint, typecheck and tests pass before creating the PR. Use clear commit messages in the Conventional Commit format.
Loading