Provide a `CONTRIBUTING.md` guideline

[bbraunstein]

I (and I'm sure others) would like to contribute to the permit-golang repository. There isn't clarity on how to implement new features in a predictable and consistent way. For example, there are disparities between the exposed REST API and the SDK. The SDK does not interact with certain endpoints and/or the generated models do not match the response objects from the API. Given that the models and other resources are generated automatically using openapi-generator.tech, no documentation exists for how a new contributor could generate/update these file. These disparities affect other integrations, such as the terraform-permit-io provider, which is very immature and not as robust as other providers on the market.

A new contributor that is interested in submitting a PR would quickly be overwhelmed and discouraged from improving PermitIO's open-source tooling. Having high-level contribution guidelines would make the repository more open and inviting to new contributors and foster better collaboration.

[danyi1212]

Hey @bbraunstein, thank you so much for the thoughtful feedback — you’re absolutely right.

You’re right that there are inconsistencies between the SDK and the API, and that the lack of contribution guidelines (especially around openapi-generator and model updates) makes it harder for new contributors to get involved.

The good news is that we’re actively working on this and plan to publish clear guidelines soon to make contributions more predictable, consistent, and accessible. Our goal is to make the SDK and surrounding tooling easier to work with and more robust across the board.

We really appreciate your interest in contributing, and we’re committed to making the process much smoother and more inviting. Stay tuned — we hope to have those updates out in the near future!

[bbraunstein]

Not here to public shame :) Happy to hear that something is being worked on.

I suspect there are probably some *.mustache templates that are not checked into the repo? Are you in any state to share them out? I'd like to submit some changes to the SDK that would be consumed by the Terraform Provider, but it requires updating some of the openapi and models packages.