chore: introduce new contibutor guide with triagers and committers #2959
Conversation
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
asyncapi-bot
requested review from
BhaswatiRoy,
J0SAL,
octonawish-akcodes,
TRohit20,
VaishnaviNandakumar and
sambhavgupta0705
|
I have opened a PR to update the docs triagers in the CODEOWNERS file: #2974. Lukasz, I am keeping Rohit, Viashnavi and the other folks since they still respond when I reach out. Hoping to keep them involved. Agreed that a few of the docs triagers were not really able to continue so makes sense to remove them. |
|
Question: @derberg, pardon, what do you mean by "something to consider is to create a dedicated website channel in slack, and have it mentioned in contrib guide." Were you thinking of opening a channel only for discussing maintainer contributions? Not sure I followed you correctly 😸 |
|
@alequetzalli
like a channel called "asyncapi website" or something, were all website discussions take place. |
derberg
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-2959--asyncapi-website.netlify.app/ |
|
/ptal share if the description is accurate, or there is not enough, especially folks that do triage of code and docs - anything from your side? should anything be added? |
|
@alequetzalli @VaishnaviNandakumar @J0SAL @octonawish-akcodes @BhaswatiRoy @sambhavgupta0705 @TRohit20 Please take a look at this PR. Thanks! 👋 |
🚢
CONTRIBUTING.md
Outdated
| @@ -36,28 +43,27 @@ The following is a summary of the ideal contribution flow. Please, note that Pul | |||
| └───────────────────────┘ | |||
| ``` | |||
|
|
|||
| ## Code of Conduct | |||
| AsyncAPI has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](./CODE_OF_CONDUCT.md) so that you can understand what sort of behaviour is expected. | |||
| Issues and pull requests without activity from the creator within 14 days will be automatically closed. However, closure does not mean rejection. If you wish to revisit a closed issue or pull request, feel free to open a new one referencing the closed item. | |||
There was a problem hiding this comment.
What if maintainers fail to acknowledge the issue within 14 days?
There was a problem hiding this comment.
I hope that never happens
so "automatically" I mean that triager or committer may automatically close the issue if it is not active
on our side
we could have maybe a sentence that if, let's say, there is no acknowledgement of maintainers in 7 or 14 days, they should use /ptal command. wdyt?
There was a problem hiding this comment.
Yeah /ptal can be a good option for the author of the issue. Kindly add this information in the doc.
CONTRIBUTING.md
Outdated
| @@ -66,14 +72,40 @@ Pull requests should have a title that follows the specification, otherwise, mer | |||
| - `test: ` prefix in the title indicates that PR is only related to tests and there is no need to trigger release. | |||
| - `refactor: ` prefix in the title indicates that PR is only related to refactoring and there is no need to trigger release. | |||
|
|
|||
| What about MAJOR release? just add `!` to the prefix, like `fix!: ` or `refactor!: ` | |||
| What about a MAJOR release? Just add `!` to the prefix, like `fix!: ` or `refactor!: ` | |||
There was a problem hiding this comment.
We don't have any release process inside the website. Do we need this point?
There was a problem hiding this comment.
yup, you;re right - will remove once we also clarify other comments
CONTRIBUTING.md
Outdated
| - Responsibilities include labeling issues and pull requests, commenting, closing, and reopening items as needed, and assisting users and novice contributors. | ||
| - Triagers play a crucial role in enforcing the contributor guide and maintaining a clean backlog. | ||
| - If a triager plans to become a committer, they should consult with existing committers to gradually gain more rights. |
There was a problem hiding this comment.
What should be the criteria for a triager to become a committer?
There was a problem hiding this comment.
I guess doing the work of a committer for some time?
not sure we are able to define, in the end someone has to gain trust of committer to become one - committer needs to be comfortable with another person to approve and merge
so committer, in theory knows triager from their work, and more or less know what knowledge they are missing and what they need to work on - help define next steps 🤔
not sure if we are able to be more specific?
There was a problem hiding this comment.
I think the clear point to become a committer from triager, is to take their stance, opinions or give suggestions on some of the critical issues in the repo, or being the part/mentor of any big/critical project idea inside website. In that way, other committers can find enough skills inside the required triager to become a committer. Moreover, the activity of triager also determines whether the person can be an active committer or not.
|
/update |
derberg
requested review from
VaishnaviNandakumar,
akshatnema,
anshgoyalevil and
quetzalliwrites
Co-authored-by: Vaishnavi <[email protected]>
CONTRIBUTING.md
Outdated
|
|
||
| What about MAJOR release? just add `!` to the prefix, like `fix!: ` or `refactor!: ` | ||
| - `fix: ` prefix in the title indicates that the PR is a bug fix. | ||
| - `feat: ` prefix in the title indicates that PR is a feature. |
There was a problem hiding this comment.
can the the PR change be applied for all points?
|
Nice to see @quetzalliwrites back ✨ 😊 |
|
/rtm |
Resolves #2586
I tired to update existing contrib guide and add new agreements we did in the issue.
We need attention of all maintainers, especially:
Arya Guptanever accepted even the invite to website repo onTriagerightsone thing I did not mention here.
something to consider is to create a dedicated website channel in slack, and have it mentioned in contrib guide. I did it already for generator project
#generator. A lot of synchro work takes place in private now, and we loose an opportunity for others to learn how maintainance and communication works in the project