Merge pull request #7 from openfetch-js/dev

Dev

Author: hamdymohamedak

CHANGELOG.md

@@ -4,7 +4,24 @@ All notable changes to this project are documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.4.0] - 2026-04-11
+## About OpenFetch
+
+**OpenFetch** (`@hamdymohamedak/openfetch`) is a small, **dependency-free** HTTP client for any JavaScript runtime that provides the standard [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) API (Node 18+, Bun, Deno, Cloudflare Workers, browsers). It focuses on a single transport layer, **no legacy browser-only globals** (`window`, `document`, `localStorage`), so it stays **SSR- and React Server Component–friendly**.
+
+**Core surface:** default export and `createClient()` / `create()` instances with `baseURL`, query `params`, `headers`, `timeout`, `signal`, body helpers, `responseType`, `validateStatus`, request/response **interceptors**, and async **middleware** wrapping the fetch adapter.
+
+**Built-in capabilities:** `OpenFetchError` with structured shapes, **`createRetryMiddleware()`** (backoff, total/per-attempt timeouts, idempotency key helpers for retried POSTs), **`MemoryCacheStore`** and **`createCacheMiddleware()`** (TTL, optional stale-while-revalidate).
+
+**Optional entry points (tree-shaking):**
+
+- `@hamdymohamedak/openfetch/plugins` — `retry()`, `timeout()`, `hooks()`, `debug()` (e.g. masked headers in logs), `strictFetch()`.
+- `@hamdymohamedak/openfetch/sugar` — **`createFluentClient()`**: URL + method chaining (`.get()`, `.post()`, …), terminals like `.json()`, `.text()`, `.send()`, **`.raw()`** (native `Response` without adapter body parsing on that path), and **`.memo()`** (one HTTP round-trip; body buffered once for multiple terminals—not HTTP cache).
+
+For a feature matrix, examples, and execution order (middleware vs retry vs interceptors), see the [README](https://github.com/openfetch-js/OpenFetch/blob/main/README.md).
+
+---
+
+## [0.2.8] - 2026-04-14
 
 ### Added
 

CONTRIBUTING.md

@@ -25,7 +25,16 @@ Describe the use case and whether it can live in userland (middleware) vs core.
 
 ### Pull requests
 
-1. **Fork** the repository and create a branch from `main` (for example `fix/timeout-signal` or `feat/cache-key`).
+#### Branch naming
+
+Use **one branch per concern**: a single feature **or** a single bug fix, not unrelated changes in the same branch.
+
+- **Features:** `features/<short-description>` — for example `features/add-retry`, `features/cache-key-override`.
+- **Bug fixes:** `bugs/<short-description>` — for example `bugs/timeout-signal`, `bugs/cache-key-collision`.
+
+Use **kebab-case** after the prefix. Keep the slug short but specific enough that reviewers can tell what the branch is for.
+
+1. **Fork** the repository and create a branch from `main` following the [branch naming](#branch-naming) rules above.
 2. **Implement** your change in `src/`. Match existing formatting and naming.
 3. **Build** locally: `npm run build` (must pass with no TypeScript errors).
 4. **Document** user-visible behavior in `README.md` and, if structural, in `docs/PROJECT_FLOW.md`.

openFetch/CONTRIBUTING.md

@@ -25,7 +25,16 @@ Describe the use case and whether it can live in userland (middleware) vs core.
 
 ### Pull requests
 
-1. **Fork** the repository and create a branch from `main` (for example `fix/timeout-signal` or `feat/cache-key`).
+#### Branch naming
+
+Use **one branch per concern**: a single feature **or** a single bug fix, not unrelated changes in the same branch.
+
+- **Features:** `features/<short-description>` — for example `features/add-retry`, `features/cache-key-override`.
+- **Bug fixes:** `bugs/<short-description>` — for example `bugs/timeout-signal`, `bugs/cache-key-collision`.
+
+Use **kebab-case** after the prefix. Keep the slug short but specific enough that reviewers can tell what the branch is for.
+
+1. **Fork** the repository and create a branch from `main` following the [branch naming](#branch-naming) rules above.
 2. **Implement** your change in `src/`. Match existing formatting and naming.
 3. **Build** locally: `npm run build` (must pass with no TypeScript errors).
 4. **Document** user-visible behavior in `README.md` and, if structural, in `docs/PROJECT_FLOW.md`.