Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (38 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

60 lines (38 loc) · 1.63 KB
Raw

Contributing

Thank you for your interest in contributing to ItalianFiscalKit.

1. Before You Start

  • Search existing issues before opening a new one.
  • For bug reports, include enough information to reproduce the problem.
  • For feature requests, explain the use case and expected behaviour.

2. Reporting Validation Issues

If you believe a Fiscal Code, Partita IVA, IBAN, municipality, or Belfiore code is being handled incorrectly, please provide:

  1. The value being validated (anonymised if necessary)
  2. The expected result
  3. The actual result
  4. Any relevant personal data or municipality information needed to reproduce the issue

3. Development Setup

Setup the pre-cheeck:

.\setup.ps1

Clone the repository and build locally:

dotnet build
dotnet test

To preview the documentation locally:

docfx .\docfx.json --serve

4. Pull Requests

Please keep pull requests focused on a single change whenever possible.

5. Coding Guidelines

  • Follow the existing coding style and project structure.
  • Prefer readability over clever implementations.
  • Avoid introducing external dependencies unless there is a strong justification.
  • Keep all validation logic fully local. The library must not require external services or HTTP calls.

6. Dataset Changes

Municipality and Belfiore data should be sourced from official or authoritative public datasets whenever possible.

When updating the dataset, please include the source and verify that the generated tests continue to pass.

7. License

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