docs: add proto extensions to readme, add makefile (#43)

adding proto extension documentation to inform how to add new
extensions.

adding a makefile to also simplify linting.

Author: toumorokoshi

.github/workflows/lint.yaml

@@ -10,7 +10,5 @@ jobs:
     container: node:20
     steps:
       - uses: actions/checkout@v3
-      - name: Install prettier.
-        run: npm install --global prettier@3.6.2
-      - name: Verify proper formatting.
-        run: prettier --check **/*.md
+      - name: run lint
+        run: make lint

.gitignore

@@ -0,0 +1 @@
+node_modules

Makefile

@@ -0,0 +1,15 @@
+# AEP Components Makefile
+
+.PHONY: lint install
+
+# Install dependencies
+install:
+	npm install
+
+# Run linting with prettier
+lint: install
+	npx prettier --check **/*.md
+
+# Format files with prettier
+format: install
+	npx prettier --write **/*.md

README.md

@@ -6,3 +6,9 @@ Common types used in AEPs
 
 [bsr-aep-conformance]: https://buf.build/aep/conformance
 [bsr-aep-type]: https://buf.build/aep/type
+
+## Protobuf Extensions
+
+aep.dev has registered the extension ids 1253-1263 with the [global extension registry](https://github.com/protocolbuffers/protobuf/blob/main/docs/options.md). Any extensions added to this project should use these values.
+
+To minimize the need to add new ids to the global registry, additions should try to re-use the existing extensions as much as possible (for example, additional field annotations should be added as fields to `aep.api.field_info`).

package-lock.json

@@ -0,0 +1,8 @@
+{
+    "name": "aep-components",
+    "version": "1.0.0",
+    "description": "AEP (API Enhancement Proposals) components and schemas",
+    "devDependencies": {
+        "prettier": "3.6.2"
+    }
+}