first commit

Author: polewskm

.editorconfig

@@ -0,0 +1,25 @@
+# http://editorconfig.org
+
+# This file is the top-most EditorConfig file
+root = true
+
+# All Files
+[*]
+charset = utf-8
+end_of_line = crlf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+
+# Configuration Files
+[*.{json,xml,props,targets,nuspec,resx,ruleset,config,yml}]
+indent_size = 2
+
+# Markdown Files
+[*.md]
+trim_trailing_whitespace = false
+
+# Web Files
+[*.{htm,html,cshtml,js,ts,css,scss}]
+indent_size = 2

.gitattributes

@@ -0,0 +1,63 @@
+###############################################################################
+# Set default behavior to automatically normalize line endings.
+###############################################################################
+* text=auto
+
+###############################################################################
+# Set default behavior for command prompt diff.
+#
+# This is need for earlier builds of msysgit that does not have it on by
+# default for csharp files.
+# Note: This is only used by command line
+###############################################################################
+#*.cs     diff=csharp
+
+###############################################################################
+# Set the merge driver for project and solution files
+#
+# Merging from the command prompt will add diff markers to the files if there
+# are conflicts (Merging from VS is not affected by the settings below, in VS
+# the diff markers are never inserted). Diff markers may cause the following 
+# file extensions to fail to load in VS. An alternative would be to treat
+# these files as binary and thus will always conflict and require user
+# intervention with every merge. To do so, just uncomment the entries below
+###############################################################################
+#*.sln       merge=binary
+#*.csproj    merge=binary
+#*.vbproj    merge=binary
+#*.vcxproj   merge=binary
+#*.vcproj    merge=binary
+#*.dbproj    merge=binary
+#*.fsproj    merge=binary
+#*.lsproj    merge=binary
+#*.wixproj   merge=binary
+#*.modelproj merge=binary
+#*.sqlproj   merge=binary
+#*.wwaproj   merge=binary
+
+###############################################################################
+# behavior for image files
+#
+# image files are treated as binary by default.
+###############################################################################
+#*.jpg   binary
+#*.png   binary
+#*.gif   binary
+
+###############################################################################
+# diff behavior for common document formats
+# 
+# Convert binary document formats to text before diffing them. This feature
+# is only available from the command line. Turn it on by uncommenting the 
+# entries below.
+###############################################################################
+#*.doc   diff=astextplain
+#*.DOC   diff=astextplain
+#*.docx  diff=astextplain
+#*.DOCX  diff=astextplain
+#*.dot   diff=astextplain
+#*.DOT   diff=astextplain
+#*.pdf   diff=astextplain
+#*.PDF   diff=astextplain
+#*.rtf   diff=astextplain
+#*.RTF   diff=astextplain

.github/copilot-instructions.md

@@ -0,0 +1,157 @@
+# Copilot Instructions for NCode.Buffers
+
+## Test Project Conventions
+
+### Unit Test Style
+
+When writing or modifying unit tests in this project:
+
+- **Do NOT use** `// Arrange`, `// Act`, `// Assert` comments in test methods
+- Use blank lines to separate the logical sections of a test instead of comments
+- Keep tests concise and readable without AAA comment annotations
+
+### Example
+
+```csharp
+[Fact]
+public void MyMethod_WhenCondition_ExpectedBehavior()
+{
+    var input = "test";
+
+    var result = MyMethod(input);
+
+    Assert.Equal("expected", result);
+}
+```
+
+## Code Style Conventions
+
+### Collection Expressions
+
+Use C# 12+ collection expressions instead of traditional array/collection initialization:
+
+```csharp
+// Preferred
+byte[] data = [1, 2, 3, 4, 5];
+List<string> names = ["Alice", "Bob"];
+int[] empty = [];
+
+// Avoid
+var data = new byte[] { 1, 2, 3, 4, 5 };
+var names = new List<string> { "Alice", "Bob" };
+var empty = Array.Empty<int>();
+```
+
+### Constants for Literals
+
+Use `const` for any literal values of any type instead of `var`:
+
+```csharp
+// Preferred
+const string expected = "hello";
+const int count = 5;
+const char separator = ',';
+const double rate = 0.15;
+
+// Avoid
+var expected = "hello";
+var count = 5;
+var separator = ',';
+var rate = 0.15;
+```
+
+### UTF-8 String Literals
+
+Use C# 11+ UTF-8 string literals (`u8` suffix) when working with byte arrays that represent valid UTF-8 text:
+
+```csharp
+// Preferred
+var bytes = "Hello"u8.ToArray();
+var utf8Bytes = "café"u8.ToArray();
+var emojiBytes = "😀"u8.ToArray();
+
+// Avoid
+byte[] bytes = [72, 101, 108, 108, 111];
+byte[] utf8Bytes = [0xC3, 0xA9]; // 'é' in UTF-8
+byte[] emojiBytes = [0xF0, 0x9F, 0x98, 0x80]; // 😀 in UTF-8
+```
+
+Note: Use explicit byte arrays for invalid UTF-8 sequences or when testing error conditions.
+
+## Code Quality
+
+### ReSharper/IDE Warnings
+
+Always fix ReSharper and IDE warnings/suggestions when modifying code. Common fixes include:
+
+- Use collection expressions where applicable (but cast when needed for generic type inference, e.g., `(byte[])[1, 2, 3]` for `ReadOnlyMemory<T>` parameters)
+- Remove redundant type specifications
+- Use `const` for compile-time constant values
+- Ensure all record struct properties are accessed to avoid "never accessed" warnings
+
+### xUnit Assertion Best Practices
+
+Use the appropriate xUnit assertions for collection sizes instead of `Assert.Equal`:
+
+```csharp
+// Preferred
+Assert.Empty(collection);           // For count == 0
+Assert.Single(collection);          // For count == 1
+
+// Avoid
+Assert.Equal(0, collection.Count);
+Assert.Equal(1, collection.Count);
+```
+
+For counts greater than 1, `Assert.Equal(expectedCount, collection.Count)` is acceptable.
+
+### Test Organization with Regions
+
+Organize unit tests within a test class using `#region` directives to group tests by the method or property under test:
+
+```csharp
+public class MyClassTests
+{
+    #region Constructor Tests
+
+    [Fact]
+    public void Constructor_WithValidInput_CreatesInstance()
+    {
+        // test code
+    }
+
+    [Fact]
+    public void Constructor_WithNullInput_ThrowsException()
+    {
+        // test code
+    }
+
+    #endregion
+
+    #region MyMethod Tests
+
+    [Fact]
+    public void MyMethod_WhenCondition_ExpectedBehavior()
+    {
+        // test code
+    }
+
+    #endregion
+
+    #region MyProperty Tests
+
+    [Fact]
+    public void MyProperty_ReturnsExpectedValue()
+    {
+        // test code
+    }
+
+    #endregion
+}
+```
+
+Region naming conventions:
+- Use `Constructor Tests` for constructor tests
+- Use `{MethodName} Tests` for method tests (e.g., `Dispose Tests`)
+- Use `{PropertyName} Property Tests` for property tests (e.g., `Span Property Tests`)
+- Use `Generic Type Tests` for tests verifying generic type parameter behavior

.github/workflows/main.yml

@@ -0,0 +1,91 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+
+name: CI
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  release:
+    types: ["published"]
+
+env:
+  BUILD_CONFIGURATION: Release
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+  DOTNET_NOLOGO: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 10.0.x
+    - name: Extract version from tag
+      uses: dhkatz/get-version-action@v3.0.0
+      id: extract_version
+    - name: Restore dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --no-restore --configuration ${BUILD_CONFIGURATION} /p:Version="${BUILD_VERSION}"
+      env:
+        BUILD_VERSION: ${{ steps.extract_version.outputs.is-semver == 'true' && steps.extract_version.outputs.version-without-v || '0.0.0' }}
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: binaries
+        path: |
+          ./*/bin/*
+          ./*/obj/*
+        if-no-files-found: error
+        retention-days: 5
+
+  test:
+    needs: [build]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: binaries
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 10.0.x
+      - name: Restore dependencies
+        run: dotnet restore
+      - name: Run rests
+        run: dotnet test --no-build --verbosity normal --configuration ${BUILD_CONFIGURATION} --logger trx
+      - name: Publish tests
+        uses: dorny/test-reporter@v1
+        if: success() || failure()
+        with:
+          name: test report
+          path: ./*/TestResults/*.trx
+          reporter: dotnet-trx
+
+  publish:
+    if: github.event_name == 'release' && github.event.action == 'published' && github.event.release.tag_name
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: binaries
+      - name: Upload release artifacts
+        run: gh release upload ${{ github.event.release.tag_name }} ./*/bin/${BUILD_CONFIGURATION}/*.nupkg ./*/bin/${BUILD_CONFIGURATION}/*.snupkg
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 10.0.x
+      - name: Publish NuGet package
+        run: dotnet nuget push ./*/bin/${BUILD_CONFIGURATION}/*.nupkg --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json