Skip to content
This repository was archived by the owner on May 10, 2021. It is now read-only.

Better README #47

Open
smoya opened this issue May 7, 2021 · 12 comments
Open

Better README #47

smoya opened this issue May 7, 2021 · 12 comments
Labels
documentation Improvements or additions to documentation

Comments

@smoya
Copy link

smoya commented May 7, 2021

This project deserves a proper README.

  • What is it about?
  • Features?
  • What's the current development status?
  • If applies, how can users install it?
  • Standard README elements such as how to contribute, license, etc.
@smoya smoya added enhancement New feature or request documentation Improvements or additions to documentation and removed enhancement New feature or request labels May 7, 2021
@github-actions
Copy link

github-actions bot commented May 7, 2021

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.

Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@derberg
Copy link
Contributor

derberg commented May 7, 2021

I'm thinking if it makes even sense to work on this, if maybe better would be to archive and convince owner of https://github.com/ivangsa/vs-asyncapi-preview to donate and work on it under asyncapi as it is already used by community but is not very much up to date

@smoya
Copy link
Author

smoya commented May 7, 2021

In the meantime, can we archive this repository and add a note redirecting to https://github.com/ivangsa/vs-asyncapi-preview ?

@derberg
Copy link
Contributor

derberg commented May 7, 2021

@smoya 100% for the archive and move to asyncapi organization for archived projects.

@fmvilas you created this repo, so you can object 😄

@ivangsa when we move your plugin under asyncapi:

  • do you want to still be a maintainer aka CODEOWNER? we need to discuss what would have to happen to get one of the regular maintainers into codeowner position here too? I guess you do not want to be the only one to not get overwhelmed by the work on reviews
  • are you ok we later republish plugin under official AsyncAPI name? (might be not so smart question as I do not really know how plugins publishing works 😄 )
  • as a CODEOWNER you can automatically become a member of Technical Steering Committee of AsyncAPI Initiative. You do not have to, but you get such a right by default. We are still setting up things here, so if you ask me what it means, what responsibilities you get, for now I would say non, as we did not finalize the setup after setting up open governance and joining Linux Foundation
  • I'm all yours if it comes to onboarding, when you have some question or things like that, maybe want a meeting about it? just lemme know

@fmvilas but I guess you won't object 😄

@fmvilas
Copy link
Contributor

fmvilas commented May 7, 2021

Kill it with fire! 🔥🔥🔥

@ivangsa
Copy link

ivangsa commented May 7, 2021

Hi
@derberg just pull/fork from my repo and refactor as you please...
when you are ready to publish it under official name, just let me know so I create and update to inform existing users they need to move to the new version manually... (I've used my name as vscode publisher and that can not be changed without breaking things)

And regarding becoming a member, it's not necesary... this was just a quick development
I have developed internally a java-parser, code generator and maven plugin (inspired in openapi-maven-generator) with the idea to contribute it to AsyncAPI initiative but burocracy is so slow I'm not sure when (or if) this is going to happen..

I'm always open to contribure with some PRs in the future... And thanks for giving this plugin some more love

@derberg
Copy link
Contributor

derberg commented May 7, 2021

@ivangsa oh, I think it would be totally unfair, and would not feel comfortable doing it. Can't we do the transfer of the repo using GitHub functionality? GitHub will handle redirects, and we will preserve the history and you as the creator, even if long term you won't be able to contribute and won't stay with the project, we want to respect that you actually triggered the community to work on this

@ivangsa
Copy link

ivangsa commented May 10, 2021

@derberg I need permission to "create public repos" in asyncapi organization in order to transfer the repo
you can later remove that permission

@derberg
Copy link
Contributor

derberg commented May 10, 2021

@ivangsa
I just invited you to the org. Go ahead and make the transfer please and let me know once it is done

@ivangsa
Copy link

ivangsa commented May 10, 2021

@derberg It's transfered!!

@derberg
Copy link
Contributor

derberg commented May 10, 2021

Awesome, I invited you there to the repo as maintainer.
Thanks a lot in the name of AsyncAPI Community!

Now we need to plan next steps 🍺

@derberg
Copy link
Contributor

derberg commented May 10, 2021

I archive this repo in favour of https://github.com/asyncapi/vs-asyncapi-preview

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants