Skip to content

Commit

Permalink
docs(support): Add SUPPORT.md file
Browse files Browse the repository at this point in the history
This commit adds a new SUPPORT.md file to provide guidelines and insights on where to find assistance with the nairobi-traffic-pcb projects. The file includes information on formulating questions, conducting searches, providing relevant code samples, and the importance of investing effort in framing questions effectively. It also includes a note to read the code of conduct before participating in the community.

The purpose of this commit is to improve the documentation and support resources for the project.

Signed-off-by: Rodney Osodo <[email protected]>
  • Loading branch information
rodneyosodo committed Nov 6, 2023
1 parent b3c09b4 commit 5f28022
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Support

This guide offers insights into where you can find assistance with your nairobi-traffic-pcb projects. Please review the following guidelines.

> 👉 **Note**: before participating in our community, please read our
> [code of conduct](CODE_OF_CONDUCT.md).
> By interacting with this repository, organization, or community you agree to
> abide by its terms.
## Help us help you

Invest time in formulating your questions and include relevant links and resources. This initial effort can save time for everyone in the long run.

Here are some tips:

- [Talk to a duck](https://rubberduckdebugging.com)!
- Don’t fall for the [XY problem](https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378)
- Conduct a search to check if a similar question has already been asked.
- Clearly define your needs:
- Is there a specific task you're trying to accomplish?
- What issue are you encountering, and what steps have you taken to resolve it?
- Is there a concept you're struggling to grasp?
- Provide sample code, such as a [CodeSandbox](https://codesandbox.io) or video, if possible
- While screenshots can be helpful, please also provide the relevant text, such as code snippets or error messages.
- The more effort you invest in framing your question, the more effectively we can assist you.

0 comments on commit 5f28022

Please sign in to comment.