asyncapi / saunter

Saunter is a code-first AsyncAPI documentation generator for dotnet.
https://www.asyncapi.com/
MIT License
194 stars 55 forks source link

[📑 Docs]: We need a roadmap!! #205

Open yurvon-screamo opened 2 months ago

yurvon-screamo commented 2 months ago

I see a large number of multidirectional activities, both in the issue and pull request parts. We need to understand what we want to change in the project first and focus on it.

We also need to determine the target architecture of the library, our style code, and understand whether we are ready to break the current api.

I will do this in early May, it is very difficult to maintain in its current form)

yurvon-screamo commented 2 months ago

I created 2 milestones, before creating new functionality, we need to deal with them, otherwise we will get chaos and problems with further backward compatibility of versions

Let's do the decomposition of the milestones

yurvon-screamo commented 1 month ago

Saunter roadmap

We need to implement these 2 points, without this it is impossible to support the project (this is my opinion)))

Code style

Issue: #202

We need to generate the target style code, come to it and automate its verification at the ci level.

Target arch

We need to create a target architecture for the product, taking into account the possibility of its creation and application in the near future

We can solve the rest of the issue only after the implementation of the first 2 points.

I would suggest starting with:

thompson-tomo commented 1 month ago

@yurvon-screamo i would suggest we also look at tackling #192 & #200 relatively soon as they would be necessary to set a good foundation.

Also happy to contribute towards developing out the library.