Add AGENTS.md

Author: xoofx

.github/copilot-instructions.md

@@ -0,0 +1,5 @@
+# GitHub Copilot Instructions
+
+Single source of truth: read and follow `../AGENTS.md`.
+
+Do not duplicate instructions here. If anything conflicts, `../AGENTS.md` wins.

.github/workflows/CI.yml

@@ -4,12 +4,16 @@ on:
   push:
     paths-ignore:
     - 'doc/**'
-    - 'changelog.md'
-    - 'readme.md'
+    - '*.md'
+    - '*.txt'
   pull_request:
 
 jobs:
   build:
+    permissions:
+      id-token: write
+      actions: write
+      contents: write
     runs-on: ubuntu-22.04
     steps:
       - name: "Build, Test, Pack and Publish"

AGENTS.md

@@ -0,0 +1,57 @@
+# LibObjectFile — Codex Agent Instructions
+
+LibObjectFile is a .NET library to read, manipulate and write linker and executable object files (e.g ELF, ar, DWARF, PE...).
+
+Paths/commands below are relative to this directory.
+
+## Orientation
+
+- Library: `src/LibObjectFile/`
+- Benchmarks: `src/LibObjectFile.Bench/`
+- CodeGen: `src/LibObjectFile.CodeGen/` (Native header to C# codegen))
+- Tests: `src/LibObjectFile.Tests/` (MSTest)
+- Docs to keep in sync with behavior: `readme.md` and the docs under `doc/` (e.g., `doc/**/*.md`)
+
+## Build & Test
+
+```sh
+# from the project root (this folder)
+cd src
+dotnet build -c Release
+dotnet test -c Release
+```
+
+All tests must pass and docs must be updated before submitting.
+
+## Contribution Rules (Do/Don't)
+
+- Keep diffs focused; avoid drive-by refactors/formatting and unnecessary dependencies.
+- Follow existing patterns and naming; prefer clarity over cleverness.
+- New/changed behavior requires tests; bug fix = regression test first, then fix.
+- All public APIs require XML docs (avoid CS1591) and should document thrown exceptions.
+
+## C# Conventions (Project Defaults)
+
+- Naming: `PascalCase` public/types/namespaces, `camelCase` locals/params, `_camelCase` private fields, `I*` interfaces.
+- Style: file-scoped namespaces; `using` outside namespace (`System` first); `var` when the type is obvious.
+- Nullability: enabled — respect annotations; use `ArgumentNullException.ThrowIfNull()`; prefer `is null`/`is not null`; don't suppress warnings without a justification comment.
+- Exceptions: validate inputs early; throw specific exceptions (e.g., `ArgumentException`/`ArgumentNullException`) with meaningful messages.
+- Async: `Async` suffix; no `async void` (except event handlers); use `ConfigureAwait(false)` in library code; consider `ValueTask<T>` on hot paths.
+
+## Performance / AOT / Trimming
+
+- Minimize allocations (`Span<T>`, `stackalloc`, `ArrayPool<T>`, `StringBuilder` in loops).
+- Keep code AOT/trimmer-friendly: avoid reflection; prefer source generators; use `[DynamicallyAccessedMembers]` when reflection is unavoidable.
+- Use `sealed` for non-inheritable classes; prefer `ReadOnlySpan<char>` for parsing.
+
+## API Design
+
+- Follow .NET guidelines; keep APIs small and hard to misuse.
+- Prefer overloads over optional parameters (binary compatibility); consider `Try*` methods alongside throwing versions.
+- Mark APIs `[Obsolete("message", error: false)]` before removal once stable (can be skipped while pre-release).
+
+## Git / Pre-Submit
+
+- Commits: commit after each self-contained logical step; imperative subject, < 72 chars; one logical change per commit; reference issues when relevant; don't delete unrelated local files.
+- Commit subjects must start with a dotnet-releaser autolabel prefix: `Breaking Change`, `Add`, `Fix`/`Bugfix`, `Enhance`/`Refactor`, `Improve Perf`, `Add`/`Improve`/`Fix`/`Update` followed by `ci`/`doc`/`test`/`example`/`translation`/`accessibility`, or `Update Depend...`/`Bump <dependency>` for dependencies. Put any GitHub issue reference at the end in parentheses, e.g. `Fix parser error (#18)`.
+- Checklist: each self-contained step is committed; build+tests pass; docs updated if behavior changed; public APIs have XML docs; changes covered by unit tests.

CLAUDE.md

@@ -0,0 +1,5 @@
+# Claude Instructions
+
+Single source of truth: read and follow `AGENTS.md`.
+
+Do not duplicate instructions here. If anything conflicts, `AGENTS.md` wins.

license.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2019, Alexandre Mutel
+Copyright (c) 2019-2026, Alexandre Mutel
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification

src/LibObjectFile.slnx

@@ -7,6 +7,7 @@
     <File Path="../.gitattributes" />
     <File Path="../.github/workflows/ci.yml" />
     <File Path="../.gitignore" />
+    <File Path="../AGENTS.md" />
     <File Path="../license.txt" />
     <File Path="../readme.md" />
     <File Path="Directory.Build.props" />

src/dotnet-releaser.toml

@@ -7,3 +7,6 @@ run_tests_for_debug = true
 [github]
 user = "xoofx"
 repo = "LibObjectFile"
+[nuget]
+user = "xoofx"
+trusted_publishing = true