Skip to content

Latest commit

 

History

History
67 lines (55 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

67 lines (55 loc) · 1.88 KB
Raw

Contributing to LocalAI.NET

Publishing to NuGet

Prerequisites

  1. Create a NuGet account at https://www.nuget.org
  2. Generate an API key:
    • Go to https://www.nuget.org/account/apikeys
    • Click "Create"
    • Name: "LocalAI.NET Publishing" (or your preferred name)
    • Expiration: 365 days
    • Select "Push new packages and package versions"
    • Glob Pattern: "LocalAI.NET*"
    • Save the generated key securely

Publishing Process

  1. Update version in LocalAI.NET/LocalAI.NET.csproj:

    <Version>1.0.0</Version>   <!-- Change this to new version -->

  2. Clean and pack:

    dotnet clean
dotnet pack -c Release

  3. Push to NuGet:

    dotnet nuget push .\LocalAI.NET\bin\Release\LocalAI.NET.1.0.0.nupkg --api-key YOUR_API_KEY --source https://api.nuget.org/v3/index.json

    Replace:

    • 1.0.0 with your new version number
    • YOUR_API_KEY with your NuGet API key

  4. Wait 15-30 minutes for the package to appear on NuGet.org

Version Guidelines

  • Use Semantic Versioning:
    • MAJOR version for incompatible API changes
    • MINOR version for backwards-compatible functionality
    • PATCH version for backwards-compatible bug fixes

Development Guidelines

Code Style

  • Use C# latest features and best practices
  • Follow Microsoft's C# Coding Conventions
  • Use meaningful names for variables, methods, and classes
  • Add XML documentation comments for public APIs

Testing

  1. Write unit tests for new features
  2. Ensure all tests pass before submitting PR: 
    dotnet test

Pull Request Process

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Update documentation and tests
  5. Submit a pull request

Questions?

Open an issue on GitHub if you have questions or need help.