Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: improve contributing guidelines #511

Merged
merged 4 commits into from
Mar 19, 2021
Merged

chore: improve contributing guidelines #511

merged 4 commits into from
Mar 19, 2021

Conversation

fmvilas
Copy link
Member

@fmvilas fmvilas commented Mar 14, 2021 •
edited
Loading

Description

  • Adds information about the new stages: strawman, proposal, draft, and accepted (or rejected).
  • Adds some guiding principles.

To-do

Related issue(s)
asyncapi/.github#37

magicmatatjahu
magicmatatjahu reviewed Mar 14, 2021
View reviewed changes
Copy link
Member

@magicmatatjahu magicmatatjahu left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment :) I think that the text is correct - because is copied entirely from graphql 😂

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
magicmatatjahu
magicmatatjahu previously approved these changes Mar 14, 2021
View reviewed changes
Copy link
Member

@magicmatatjahu magicmatatjahu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🆗 Please wait for rest of mates :)

@derberg
Copy link
Member

derberg commented Mar 15, 2021

who is the champion? I mean who can be a champion? where can I find a champion for my case?

@smoya
Copy link
Member

smoya commented Mar 15, 2021

who is the champion? I mean who can be a champion? where can I find a champion for my case?

+1 to this question.

jonaslagoni
jonaslagoni reviewed Mar 15, 2021
View reviewed changes
Copy link
Member

@jonaslagoni jonaslagoni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean that a champion MUST know how to code JavaScript? 🤔 Or can they have something like co-champions?

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@fmvilas
Copy link
Member Author

fmvilas commented Mar 15, 2021

who is the champion? I mean who can be a champion?

A champion is anyone who wants to take the lead on implementing the feature. It doesn't mean it's the only person working on it though. Think about this role as a "person of reference".

where can I find a champion for my case?

Usually in the issue itself. Anyone can jump in and say they want to champion that feature. Or in case the old champion isn't responding and there's a PR already, a new person can comment on the PR.

Does this mean that a champion MUST know how to code JavaScript? 🤔 Or can they have something like co-champions?

A champion is a "person of reference" for that feature. The champion may or may not know about JS and rely on the help of other community members to implement the feature on the JS parser.

@derberg
Copy link
Member

derberg commented Mar 15, 2021

@fmvilas well explained, will you add it? 😄

@fmvilas
Copy link
Member Author

fmvilas commented Mar 15, 2021

Ok! I thought it was a common term, like "maintainers". I'll add it anyway.

@jonaslagoni
Copy link
Member

jonaslagoni commented Mar 15, 2021 •
edited
Loading

A champion is a "person of reference" for that feature. The champion may or may not know about JS and rely on the help of other community members to implement the feature on the JS parser.

Would probably be great to add the part about they are not expected to know JS and do the implementation on their own if they can't. Just to ensure people aren't "scared" away by the fact that there has to be some underlying code implementation.

@fmvilas
Copy link
Member Author

fmvilas commented Mar 15, 2021

Added the definition of "champion" and linked it in the first occurrence on the document.

derberg
derberg previously approved these changes Mar 15, 2021
View reviewed changes
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think going GraphQL way, meaning already battle-proof way is the best we can do here 👍🏼
I approve but suggest leaving it open for few days as maybe someone from the community has some comments

jonaslagoni
jonaslagoni previously approved these changes Mar 15, 2021
View reviewed changes
Copy link
Member

@jonaslagoni jonaslagoni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@fmvilas
Copy link
Member Author

fmvilas commented Mar 15, 2021

@derberg Yes. Would you mind sharing it on social media? I think it deserves some attention.

magicmatatjahu
magicmatatjahu previously approved these changes Mar 15, 2021
View reviewed changes
smoya
smoya previously approved these changes Mar 15, 2021
View reviewed changes
Copy link
Member

@smoya smoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@derberg
Copy link
Member

derberg commented Mar 15, 2021

@fmvilas

This was referenced Mar 16, 2021
Merged
Closed
@derberg derberg mentioned this pull request Mar 16, 2021
Closed
@fmvilas fmvilas added the 🐝 Process Related to Governance, Tools, or other meta work label Mar 18, 2021
@fmvilas fmvilas dismissed stale reviews from magicmatatjahu, jonaslagoni, and derberg via e53a799 March 19, 2021 17:21
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@fmvilas fmvilas merged commit dbae6ac into asyncapi:master Mar 19, 2021
@fmvilas fmvilas deleted the improve-contributing-guidelines branch March 19, 2021 17:25
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@derberg
Copy link
Member

derberg commented May 24, 2021

It is actually not included in the release. This was an unintentional release caused by the release automation initial run. 1.0 version of the spec was released a long time ago. The release mentioned by the bot was removed.

@derberg derberg removed the released label May 24, 2021
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 2.1.0-2021-06-release.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 2.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@derberg
Copy link
Member

derberg commented Jun 15, 2021

Not included in release 2.1 yet, 2.1 was mistakenly triggered by our automation.

@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 2.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] approved these changes

@smoya smoya smoya left review comments

@derberg derberg derberg left review comments

@jonaslagoni jonaslagoni jonaslagoni left review comments

@magicmatatjahu magicmatatjahu magicmatatjahu left review comments

Assignees
No one assigned
Labels
🐝 Process Related to Governance, Tools, or other meta work released on @2021-06-release released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@fmvilas @derberg @smoya @jonaslagoni @asyncapi-bot @magicmatatjahu