Skip to content

Commit

Permalink
Add a Brief Slack best practices page
Browse files Browse the repository at this point in the history
  • Loading branch information
oleg-nenashev committed Feb 28, 2024
1 parent 34faff9 commit b0acfcb
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/contributing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ This is a main channel for Q&A and quick discussions.
- [Join the Community Slack](https://gradle.org/slack-invite)
- Use the `#contributing` channel if you need any help with contributing
changes to gradle and getting them over the line.
- We have a searchable Slack archive [here](https://www.linen.dev/s/gradle-community).

We use a free account, so the Slack history is limited to 3 months.
We keep the searchable Slack archive [here](https://www.linen.dev/s/gradle-community).
Learn more about Slack and the communication best practices on [this page](./community-slack.md).

### Gradle Forums

Expand Down
75 changes: 75 additions & 0 deletions docs/contributing/community-slack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: "Gradle Community Slack"
description: >
There is a community Slack workspace we use for community support,
real-time discussions and contributor collaboration.
If you use Gradle, it is a good channel to join!
---

[![Gradle Community Slack badge](https://img.shields.io/badge/slack-Join%20the%20channel-brightgreen?style=flat&logo=slack)](https://gradle.org/slack-invite)

If you need help with Gradle Build Tool, its ecosystem or integrations, or with Gradle Build Scan,
we have a `gradle-community` workspace on Slack.
The same workspace is used for real-time technical discussions and contributions coordination.
So, if you are interested in [contributing to Gradle](./README.md), join our Slack too!

The community Slack is intended to be a safe and welcoming environment,
and hence the [Gradle Code of Conduct](https://gradle.org/conduct/)
applies to **all** participants and conversations on this resource.

## Join us on Slack

To join the Slack, you can get a sign-up link [here](https://gradle.org/slack-invite).

## Key Chats

> COMING SOON: Key channels overview
## Best Practices

### Slack or other channels?

We recommend using Slack as a channel for real-time communications that are relatively short term,
and can be safely archived after 1-2 months.
For other cases, other channels might be preferable:

1. If you want to report a confirmed and reproducible issue with Gradle Build Tool or other component,
use GitHub Issues of the respective GitHub repository associated with the component.
2. For getting feedback on large-size proposals that will take many months to implement,
it is better to make proposals on Gradle Forums on Discourse: [discuss.gradle.org](https://discuss.gradle.org).
You can still use Slack to facilitate the discussion

### Asking questions on Slack

We use the Slack workspace for community support,
and most of the support requests are handled by volunteers.
Hence, let's help them to navigate and respond to questions.
And, as everywhere, please be kind and patient!

- Use threads for discussions and responding to questions
- Avoid posting the same question on multiple channels.
One channel is enough, and if needed to repost to another channel, post the link to avoid duplication.
- Avoid sending welcome/hi messages without a question.
We all try to be polite here, but you do not need to wait for an initial response before
asking the actual questions.
- To preserve the vertical space, in the first message, just briefly describe the problem.
Put all details/samples/logs in the thread responses.
- For short messages, use emojis when convenient: `:+1:`, `:-1:`, `:ok:`, etc.
- Do not hesitate to edit an opening message or the context messages based on the discoveries
It is better than reposting the whole message.

Slack moderators may warn you and ask to amend the messages,
and, in some cases, they may also edit or delete the messages as a last resort,
for example, when they appear as spam.

## Conversation Archive

We use a free account, so the Slack history is limited to 3 months.
To mitigate that, we keep
the searchable Slack archive [here](https://www.linen.dev/s/gradle-community).

You can also search across Slack history and multiple other channels on [gradle.org/help](https://gradle.org/help/).

## Alternative Channels

See the list of other community channels [here](../README.md)
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ nav:
- Home: README.md
- Participate:
- Getting Started: contributing/README.md
- Community Slack: contributing/community-slack.md
- Contribute to Gradle Build Tool: gradle/CONTRIBUTING.md
- Contributing to Documentation:
- Overview: contributing/documentation/README.md
Expand Down

0 comments on commit b0acfcb

Please sign in to comment.