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

Create Slack and GitHub etiquette guidelines #845

Open
benjagm opened this issue Dec 21, 2024 · 5 comments
Open

Create Slack and GitHub etiquette guidelines #845

benjagm opened this issue Dec 21, 2024 · 5 comments
Labels
Status: Available No one has claimed responsibility for resolving this issue.

Comments

@benjagm
Copy link
Collaborator

benjagm commented Dec 21, 2024

Work Summary

Creating a GitHub and Slack etiquette guide would be a great complement to the CoC, ensuring a good collaboration environment. More often, maintainers or reviewers are tagged in PRs, and communication is disrupted in Slack.

Example of Slack Community Etiquette:

Some additional GitHub etiquette recommendations we'd like to include here:

  • Avoid Unnecessary Mentions: Mention others only when necessary to respect their time and attention.
  • Especially for first-time contributors, avoid starting working on an issue without making sure 1) the triage process has ended, and the issue is available for contributors to start working on it and, 2) the maintainer assigned the issue to you.

Other docs to connect with this guide:
#353 - How do I ask a good question?

Call to action?

Do you think this is a good idea? What other etiquette recommendations can we add here?

@benjagm benjagm added the Status: Triage This is the initial status for an issue that requires triage. label Dec 21, 2024
@aialok
Copy link
Member

aialok commented Dec 22, 2024

I think that for the triage process, when an issue or PR is created, we should comment with the PR/Issue guidelines, stating all the necessary details such as how the triage process works. If we are just creating simple documentation and storing it somewhere in our repository, most new contributors might not read this etiquette or guideline. It would be better to automatically add a comment with all the guidelines via GitHub Actions whenever an issue or PR is created.

https://json-schema.slack.com/archives/C05FQEMV8V6/p1734783048461039?thread_ts=1734771506.346999&cid=C05FQEMV8V6

@benjagm benjagm added Status: Available No one has claimed responsibility for resolving this issue. and removed Status: Triage This is the initial status for an issue that requires triage. labels Jan 7, 2025
@benjagm
Copy link
Collaborator Author

benjagm commented Jan 7, 2025

@Honyii thoughts on this?

@Honyii
Copy link
Contributor

Honyii commented Jan 8, 2025

@benjagm great points about the etiquettes, what we can do is to create a list of these and;

  • For slack - pin it to the general channel and also add it to the contributing guidelines.
  • For Pr - I agree with @aialok 's comment. However, what happens when a pr isn't attended to for more than maybe 30/90 days ( or the max number of days a pr shouldn't be left open).
    Should we create an automation that reminds anyone that may be responsible to review the pr?

Lastly, I can start drafting the slack and github etiquettes once we finalize on this.

@aialok
Copy link
Member

aialok commented Jan 8, 2025

We do already have automation for PR to check whether it got stale or not after certain amount of time.

@benjagm
Copy link
Collaborator Author

benjagm commented Jan 18, 2025

@Honyii lets discuss this in our next 1:1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Available No one has claimed responsibility for resolving this issue.
Projects
None yet
Development

No branches or pull requests

3 participants