Onboarding guide for asycapi/glee
Welcome new maintainer! Now that you have been voted in as a new asyncapi/glee maintainer, we wanted to make sure we got you off to a good start.
The primary objective of a core maintainer is to further CLI's goal of being both an awesome command Line Interface and a thriving and friendly community.
All maintainers are expected to do the following:
- Positively represent asyncapi/glee
- Hang out in the
#04_toolingSlack channel - Participate in formal decision making in terms of the project
- Uphold the code of conduct (that is, not just follow, but cultivate that as part of the project's culture)
- Triage the issue queue: This is the tactful process of responding to often-frustrated users who file bugs or request features. We take turns "owning" this responsibility week to week.
- Slack champion: Provide assistance, resolve queries, and address any issues in the Slack channel. Additionally, keep the community informed with regular updates on development progress.
- Review PRs: This is the process of reading code from others, offering constructive and friendly guidance when necessary, and ultimately deciding whether it meets the project requirements.
- A Code of Conduct violation is a case where someone appears to have transgressed the code of conduct.
- A Bad Actor is someone who is causing harm to the project (intentionally or unintentionally) through their words or actions.
If you feel like you are up to it, the best first response to either is an attempt at gentle redirection. If you do not feel like you are up for that, contact one or more of the other core maintainers and let them know about the situation. Collectively, we must make it an obligation to protect the community, and enforce standards of conduct.
Glee is a spec-first framework that helps you build server-side applications. It leverages the AsyncAPI specification to make you more productive:
- It makes sure your code and AsyncAPI definition are on par. No more outdated documentation. Glee takes care of it for you, automatically.
- Glee lets you focus on what matters and handles the rest for you. You only write the code for your business use-case. Glee takes care of performance, scalability, resilience, and everything you need to make your application production-ready.
This is a very good place to start learning about GLEE.
Maintainers take turns triaging the issue queue. The responsibilities of a triaging run are:
- Tag all new issues
- Bugs are tagged
bug - Feature requests are tagged
enhancement - The "default" is to tag an issue as a
question/support - Anything having to do with docs are tagged
📑 docsand such issues are found here - If the fix is simple (<10 lines of code), tag it
good first issue - If a feature is deemed a Good Idea (TM), but not something we're likely to do in the near future, label it
help wanted
- Bugs are tagged
Asyncapi/glee is a community-driven project. We desire community-contributed code. The role of maintainer, in regards to the code, is to ensure that new PRs stay true to asyncapi/glee's intent, solve real problems for real users, and meet our quality guidelines.
- Cli's intent: Make CLI easy to install, use and get to solution as fast as possible.
- Quality Guidelines: We are not perfectionists. But we are enthusiasts for clarity, maintainability, and consistency.
When reviewing PRs, we need to be actively encouraging to the submitter. Strive to not leave a PR review with only "fix-it" comments. Add at least one positive note (and saying "thanks for the PR" does not count).
Details on How We Review PRs If a PR passes the "Intent" and "Solves Problems" criteria above, we view our goal as getting the PR into shape and merged with minimal frustration to the submitter.
Details on Merging PRs A PR can only be merged only if:
- All tests are passing for that PR (Circle is green)
- The PR has been approved by one of the codeowner of the project.