cli icon indicating copy to clipboard operation
cli copied to clipboard

feat: update contributing guidelines

Open Souvikns opened this issue 5 months ago • 4 comments

🎉🎉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 https://github.com/asyncapi/cli/issues/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.

Souvikns avatar Jun 15 '25 17:06 Souvikns

🦋 Changeset detected

Latest commit: abd454b966e5574cfe370565efd222a46392d6e2

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

changeset-bot[bot] avatar Jun 15 '25 17:06 changeset-bot[bot]

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:.

github-actions[bot] avatar Jun 15 '25 17:06 github-actions[bot]

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

Shurtu-gal avatar Jun 17 '25 08:06 Shurtu-gal

This pull request has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Oct 16 '25 00:10 github-actions[bot]