express-version-route 1.2.14 → 1.2.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/AGENTS.md ADDED
@@ -0,0 +1,35 @@
1
+ # AGENTS.md
2
+
3
+ Guidance for AI coding agents working in this repository.
4
+
5
+ ## Start Here
6
+
7
+ Before making changes, read:
8
+
9
+ - `CONTRIBUTING.md` for contribution, PR, testing, commit, and agent-specific expectations.
10
+ - `RELEASE.md` for release workflow details.
11
+ - `README.md` for user-facing behavior, install/use examples, and package or app overview.
12
+ - `docs/README.md` for the project documentation index.
13
+ - `docs/development.md` for local setup and development workflows.
14
+ - `docs/testing.md` for test strategy, commands, and verification expectations.
15
+ - `docs/architecture.md` for project structure, boundaries, and important invariants.
16
+ - `docs/conventions.md` for project-specific coding, documentation, and maintenance conventions.
17
+
18
+ Treat those files as the source of truth. Do not duplicate or reinterpret their rules here.
19
+
20
+ ## Documentation
21
+
22
+ - Keep documentation in sync when changing behavior, public interfaces, workflows, architecture, configuration, or operational assumptions.
23
+ - Put project-specific development details in `docs/`; keep root files focused on their standard audiences.
24
+ - Prefer linking to the source of truth over duplicating long instructions across files.
25
+ - When adding new docs, link them from `docs/README.md` and update this file only when they become important entry points for future agents.
26
+
27
+ ## PRs and Issues
28
+
29
+ - Follow PR, issue, and agent-labeling rules in `CONTRIBUTING.md`.
30
+ - Use the issue-linking format specified in `CONTRIBUTING.md`.
31
+
32
+ ## Releases
33
+
34
+ - Follow `RELEASE.md` for release workflow and changeset creation steps.
35
+ - If this project uses changesets, treat `RELEASE.md` and any changeset guidance in `CONTRIBUTING.md` as authoritative.
package/README.md CHANGED
@@ -163,6 +163,10 @@ Several npm projects exist which provide similar API versioning capabilities to
163
163
  * https://github.com/elliotttf/express-versioned-routes
164
164
  * https://github.com/biowink/express-route-versioning
165
165
 
166
+ ## Documentation
167
+
168
+ - [Project documentation](./docs/README.md) - development, testing, architecture, and conventions.
169
+
166
170
  ## Contributing
167
171
 
168
172
  Please consult [CONTRIBUTING](./CONTRIBUTING.md) for guidelines on contributing to this project.
package/RELEASE.md ADDED
@@ -0,0 +1,22 @@
1
+ # Release
2
+
3
+ This project uses [Changesets](https://github.com/changesets/changesets) for versioning and release notes.
4
+
5
+ ## Release Flow
6
+
7
+ 1. Ensure all intended changes are merged and CI is green.
8
+ 2. Run `yarn version` to apply Changesets version and changelog updates.
9
+ 3. Review the generated package and changelog changes.
10
+ 4. Run the release command, if configured for the repository.
11
+
12
+ No root `release` script is currently defined. Use the repository's publishing workflow or add one before publishing.
13
+
14
+ ## Changesets
15
+
16
+ Add a changeset for user-facing package behavior changes:
17
+
18
+ ```sh
19
+ yarn changeset
20
+ ```
21
+
22
+ Documentation-only, test-only, and internal refactor PRs usually do not need a changeset unless they describe or accompany a release-worthy behavior change.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "express-version-route",
3
- "version": "1.2.14",
3
+ "version": "1.2.15",
4
4
  "description": "provides middleware to load controllers based on api versions",
5
5
  "main": "index.js",
6
6
  "scripts": {