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

Add a doc on writing a good support request #464

Merged
merged 2 commits into from
Sep 25, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions community/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,12 @@
"path": "community/good-member/pull-requests.md",
"title": "Pull Requests",
"blurb": "How to make a great Pull Request"
},
{
"uuid": "d8aff5ac-fa35-40e2-8acd-d2693f9b30b6",
"slug": "being-a-good-community-member/writing-support-requests",
"path": "community/good-member/writing-support-requests.md",
"title": "How to write a good support request",
"blurb": "Want help? Help yourself by learning how to write a good support request!"
}
]
57 changes: 57 additions & 0 deletions community/good-member/writing-support-requests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# How to write a good support request

Want help with an Exercism?
Help boost your chances of getting a good response by learning how to write a good support request and encouraging our community to support you.

Here are some key tips.

## Use codeblocks, not images

When you want to share code (either that you've written, or instructions), use a codeblock, not an image.

As developers, we're much quicker at reading code than having to zoom into image to see things.
And many of our users use screenreaders, which cannot read out images.
So if you want to want to be a good community citizen, encourage our volunteers to help you, and look like a pro, share your code as text not an image!

For example, you can type the following:

````
```
for number in range(10):
total += number;
```
````

That will get rendered like this:

```
for number in range(10):
total += number;
```

You can even get syntax highlighting by adding the language to the codeblock opening:

````
```python
for number in range(10):
total += number;
```
````

which turns into:

```python
for number in range(10):
total += number;
```

## Use inclusive language

Exercism is made up of people of different genders.
If you turn up in our Discord and say things like "Hey boys", you're immediately excluding half of our community.
That means they're less likely to help you, but it means that the rest of the community are less likely to help you too, as we value inclusivity at Exercism.

So if you want to get help, and you want to be a nice person, don't use gender-specific language.
Try "Hey folks", "Hey everyone" or go really bold and choose "Hey fellow Exercists!"

For more on this read our article on [the words that we use](./the-words-that-we-use).