Skip to content

feat: update contributing guidelines #1802

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.

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Souvikns
Copy link
Member

🎉🎉New Changes for Maintainers and Contributors.

After consulting @Shurtu-gal and @AayushSaini101 I am proposing some changes to how we maintain CLI. As the project grows and attracts more users, the number of incoming issues has increased significantly, making it challenging to manage. To address this, we need a structured triage system to efficiently distribute the workload among maintainers and ensure timely, effective solutions.

Divide the project into scope

Inspired by the approach used in the website repository, it would be beneficial to divide the project into distinct scopes and assign maintainers to each one. This way, maintainers can focus on specific areas rather than the entire project, helping to reduce individual workload and improve overall efficiency.

As of now we can create: (Considering #1794)

  • core
  • commands
  • server-api
  • docs
  • GitHub Action
  • ci/cd

We create appropriate labels for these scopes.

Use GitHub project to triage

We already have a GitHub project which is good enough, I propose adding a new Custom Field that allows maintainers to assign themselves as the champion of an issue. This will clearly indicate who is taking responsibility, helping to avoid duplication of effort and allowing other maintainers to focus on different issues.

Contributors

A small update for contributors: if you're assigned to an issue but don’t open a PR, start work, or communicate with the responsible maintainer within a week, you may be unassigned so that someone else can take it on. We've observed that some contributors claim issues and then go inactive, which ends up blocking progress.

Weekly or bi-weekly meetings

To boost engagement with contributors and the community, I suggest we hold weekly meetings where maintainers can discuss ongoing issues, blockers, and share updates. These sessions can also be a space to hang out, exchange ideas, and connect with the community more informally.


😊 Lets have a discussion on this feel free to come with ideas and perspective.

Copy link

changeset-bot bot commented Jun 15, 2025

🦋 Changeset detected

Latest commit: abd454b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@asyncapi/cli Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

Changeset has been generated for this PR as part of auto-changeset workflow.

Please review the changeset before merging the PR.
---
'@asyncapi/cli': minor
---

feat: update contributing guidelines

- 95582d7: feat: update contributing guidelines

If you are a maintainer or the author of the PR, you can change the changeset by clicking here

Tip

If you don't want auto-changeset to run on this PR, you can add the label skip-changeset to the PR or remove the changeset and change PR title to something other than fix: or feat:.

Copy link

@Shurtu-gal
Copy link
Collaborator

Might need to give some more thoughts to the Github Project. Should discuss in upcoming meeting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: To Triage
Development

Successfully merging this pull request may close these issues.

2 participants