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.

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

Issue to review the contributing document and add a triage process proposal #538

Merged
merged 19 commits into from
Feb 16, 2024

Conversation

benjagm
Copy link
Collaborator

@benjagm benjagm commented Nov 22, 2023

Summary
GitHub Issue: #583

  • Review the Readme or equivalent.
  • The main place with the link to contribute.
  • Repo shield badges.
  • Review the contributing guide or equivalent and improve if necessary
  • Review triage
  • All contributors are visible and aligned
  • Review all the places where this contribution path is enabled and make it consistent
  • Document the role of Community Manager

Do you think resolving this issue might require an Architectural Decision Record (ADR)? (significant or noteworthy)

No

…oposal

As per issue #508 this PR is intended to review the org wide contributing document and provide a standard approach for issues triage.
@Relequestual
Copy link
Member

Relequestual commented Jan 8, 2024

We currently use a modified Sensible Github Labels list of labels: https://github.com/Relequestual/sensible-github-labels. I'd like to continue to use that as the basis, and not have similar/overlapping labels to keep it consistent across the org.

Broadly though, this looks good.

I'd like to have all new issues have a triage label.

I feel we should use all the severity labels defined. I think "priority" makes better sense given it's not nesecerily an issue of severity.

Whatever we end up with, we also need to make sure it is applied to all active repos, which includes making sure they have the labels and an updated readme, which may just direct to this document.

TRIAGE.md Outdated Show resolved Hide resolved
TRIAGE.md Outdated Show resolved Hide resolved
Copy link
Member

@Relequestual Relequestual 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 this is a great first start, which puts us in a much better place than previous. Let's re-work per my comments. (Obviously, more comments and reviews welcome.)

@benjagm
Copy link
Collaborator Author

benjagm commented Jan 17, 2024

We currently use a modified Sensible Github Labels list of labels

Thanks @Relequestual . Sensible GitHub labels are pretty flexible and cover most use cases. Is there any place where we have documented what is the modification we are using? I just found : https://github.com/json-schema-org/json-schema-spec?tab=readme-ov-file#status

@benjagm
Copy link
Collaborator Author

benjagm commented Jan 18, 2024

Let's re-work per my comments. @Relequestual

Please take a look to the new version I just pushed. Hope it reflects all the feedback provided.

@benjagm
Copy link
Collaborator Author

benjagm commented Jan 18, 2024

There is a new version of the PR ready addressing all the comments received.

@benjagm benjagm requested a review from Relequestual January 18, 2024 06:09
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@Relequestual Relequestual left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks for doing this work!

@benjagm benjagm marked this pull request as draft February 14, 2024 11:39
@benjagm benjagm marked this pull request as ready for review February 15, 2024 12:41
@Relequestual Relequestual self-requested a review February 16, 2024 11:10
Copy link
Member

@Relequestual Relequestual left a comment

Choose a reason for hiding this comment

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

Two very minor suggestions, otherwise it looks great!
Thank you for your work on this. Looks so much better.
If you agree with the suggestions, please feel free to merge after accepting them 🥳

CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@benjagm
Copy link
Collaborator Author

benjagm commented Feb 16, 2024

If you agree with the suggestions, please feel free to merge after accepting them 🥳

Thanks for the review and the suggestions @Relequestual !! Let's merge it!

@benjagm benjagm merged commit d365425 into main Feb 16, 2024
@benjagm benjagm deleted the benjagm-contributing-exp branch February 16, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants