Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (36 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.49 KB

Contributing to dotnet-nwpie-foundation-sdk

Thank you for your interest in contributing! Here's how to get started.

Development Setup

git clone https://github.com/osisdie/dotnet-nwpie-foundation-sdk.git
cd dotnet-nwpie-foundation-sdk
dotnet restore
dotnet build
dotnet test

Prerequisites: .NET 8 SDK (or later)

How to Contribute

  1. Fork the repository
  2. Create a branch: git checkout -b feature/my-feature
  3. Make your changes and add tests where applicable
  4. Run tests: dotnet test
  5. Submit a pull request with a clear description of your changes

Project Structure

src/            # SDK modules (each module is self-contained)
tests/          # Unit and integration tests
samples/        # Sample applications (MiniSite, Serverless)
docker/         # Docker configurations
build/          # Build scripts and configurations

Coding Guidelines

  • Library projects target netstandard2.1 for broad compatibility
  • Application projects (endpoints, lambdas) multi-target net8.0 and net10.0
  • Follow existing naming conventions and code style
  • Add unit tests for new functionality
  • Keep modules self-contained and loosely coupled

Reporting Issues

License

By contributing, you agree that your contributions will be licensed under the MIT License.