Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (44 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

65 lines (44 loc) · 1.29 KB

Contributing to AspNetCore.SecurityKey

Thank you for considering contributing to AspNetCore.SecurityKey! We welcome contributions from the community.

How to Contribute

Reporting Issues

  • Use the GitHub issue tracker to report bugs or request features
  • Provide clear reproduction steps for bugs
  • Include environment information (.NET version, OS, etc.)

Pull Requests

  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes
  4. Add or update tests as needed
  5. Ensure all tests pass
  6. Update documentation if needed
  7. Submit a pull request

Development Setup

  1. Clone the repository:

    git clone https://github.com/loresoft/AspNetCore.SecurityKey.git

  2. Build the solution:

    dotnet build

  3. Run tests:

    dotnet test

  4. Run samples to test your changes:

    cd samples/Sample.MinimalApi
dotnet run

Code Style

  • Follow existing code conventions
  • Use meaningful variable and method names
  • Add XML documentation for public APIs
  • Keep methods focused and concise

Testing

  • Write unit tests for new functionality
  • Ensure existing tests continue to pass
  • Test with the sample applications

Questions?

Feel free to open an issue for any questions about contributing.