How should people contribute to this project?

[RonSijm]

Hey there,

I started using the specs, and I was curious how people should be contributing. As I'm generating my client and am using it, I'm noticing some things are slightly incorrect, or missing.

As I understand it correctly, the lemmy_spec.yaml file is auto-generated, right?

So I suppose it wouldn't really make sense to send PRs with fixes directly to the specs, right? Or is that still useful to know what the end result should be or something?

[MV-GH]

I have a CONTRIBUTING.md which sheds some light on the internals and what is autogenerated. I shall add a link to this in the README.md for better visibility

[RonSijm]

Hehe, yea, I saw the CONTRIBUTING.md - and it has a chapter of How does it work and How to run it -

But not really info on how to contribute or what to do if I'm noticing anything incorrect in the spec file 🙈

[MV-GH]

Alright If you want to modify the non automated parts of the spec than you will have to modify api_routes.yaml
For the automated parts you would have to update the relevant script in /src

[MV-GH]

I have updated the CONTRIBUTING.md to include a section for that