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

feat: add slack etiquettes #6178

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Honyii
Copy link

@Honyii Honyii commented Jan 9, 2025

closes #6173

@xingyaoww xingyaoww requested a review from mamoodi January 9, 2025 20:27
@@ -121,3 +121,20 @@ We need to be more careful with changes to the core agent, as it is imperative t
If it improves accuracy, efficiency, or both with only a minimal change to code quality, that's great we're happy to merge it in!
If there are bigger tradeoffs (e.g. helping efficiency a lot and hurting accuracy a little) we might want to put it behind a feature flag.
Either way, please feel free to discuss on github issues or slack, and we will give guidance and preliminary feedback.

### Slack Etiquettes
Copy link
Collaborator

Choose a reason for hiding this comment

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

@rbren since you already approved this on Slack. Do you think this should go here? Do you want it anywhere in the code base or is pinning to Slack enough?

- When asking for help or raising issues, include necessary details like links, screenshots, or clear explanations to provide context.
- Keep discussions in public channels whenever possible to allow others to benefit from the conversation, unless the matter is sensitive or private.
- Always adhere to the [Code of Conduct](https://github.com/All-Hands-AI/OpenHands/blob/main/CODE_OF_CONDUCT.md) to ensure a welcoming and collaborative environment.
- After posting a message containing links, disable any auto-generated previews unless they provide essential context to the message.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just to note, this is not the current custom, I don't think. To the contrary, previews are enabled a lot, the context from github issues doesn't, to my knowledge, bother anyone, and at least on research previews I'm pretty sure it's actually helpful.

- Avoid using flashing, blinking, or flickering emojis and GIFs, as they may trigger photosensitive epilepsy.
- Post questions or discussions in the most relevant channel (e.g., [#general](https://app.slack.com/client/T06P212QSEA/C06P5NCGSFP) for general topics, [#questions](https://openhands-ai.slack.com/archives/C06U8UTKSAD) for queries/questions).
- When asking for help or raising issues, include necessary details like links, screenshots, or clear explanations to provide context.
- Keep discussions in public channels whenever possible to allow others to benefit from the conversation, unless the matter is sensitive or private.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is very good, I'm not sure it helps being written here, but I guess one can try. 😅

- Communicate respectfully and professionally, avoiding sarcasm or harsh language, and remember that tone can be difficult to interpret in text.
- Use threads for specific discussions to keep channels organized and easier to follow.
- Tag others only when their input is critical or urgent, and use @here or @channel sparingly to minimize disruptions.
- Before asking questions, check existing resources such as pinned messages, documentation, or previous conversations.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- Before asking questions, check existing resources such as pinned messages, documentation, or previous conversations.

- Post questions or discussions in the most relevant channel (e.g., [#general](https://app.slack.com/client/T06P212QSEA/C06P5NCGSFP) for general topics, [#questions](https://openhands-ai.slack.com/archives/C06U8UTKSAD) for queries/questions).
- When asking for help or raising issues, include necessary details like links, screenshots, or clear explanations to provide context.
- Keep discussions in public channels whenever possible to allow others to benefit from the conversation, unless the matter is sensitive or private.
- Always adhere to the [Code of Conduct](https://github.com/All-Hands-AI/OpenHands/blob/main/CODE_OF_CONDUCT.md) to ensure a welcoming and collaborative environment.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This might be already said elsewhere?

- Tag others only when their input is critical or urgent, and use @here or @channel sparingly to minimize disruptions.
- Before asking questions, check existing resources such as pinned messages, documentation, or previous conversations.
- Be patient, as open-source contributors and maintainers often have other commitments and may need time to respond.
- Avoid using flashing, blinking, or flickering emojis and GIFs, as they may trigger photosensitive epilepsy.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- Avoid using flashing, blinking, or flickering emojis and GIFs, as they may trigger photosensitive epilepsy.

I don't think this happens?

@enyst
Copy link
Collaborator

enyst commented Jan 12, 2025

@Honyii I appreciate the write-up! I do think it's helpful if it's simple and easy to parse at a glance. You know, humans have a fairly limited context too. 😂

I made a few suggestions to simplify it a bit. Just thinking we can always add things if they prove needed, but if you care about them a lot, feel free to leave them in.

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.

Feat: Add slack etiquettes to the contributing.md file
3 participants