Skip to content

howToCodeWell/how-to-ask-a-question

Repository files navigation

path date
/
2019-12-21

How To Ask a Coding Question

Before asking a coding question on Discord please read the following:

  1. Please check Google or Stack overflow first If you can't find the solution then please use the coding-help channel in the Discord server. When writing your question please do the following:
  2. State the problem or desired goal.
  3. For larger code files, limit the code you post to the targeted issue
  4. Add any log messages that you think are relevant
  5. Use 3x backticks before and after your code to format it See below:

Formatting code when asking for code help

Please write your code in a code block.

  1. Single lines/words/inline code.

Wrap the code in single back ticks ' ` <YOUR_CODE> ` ' like this: $this->isWrappedInSingleBackTicks()

  1. Multiple lines:

Wrap multiple lines of code in three back ticks ' ``` <YOUR__LONGER__CODE> ``` ' like this:

function thisIsWrappedInThreeBackTicks() {
         return [
                'formatted_code' => 'is_easier_to_read'
        ]
}
  1. Highlight your syntax

Add the programming language to the first back ticks ````php ```` like this:

function thisIsWrappedInThreeBackTicks() {
         return [
                'formatted_code' => 'is_easier_to_read'
        ]
}

Or ````css ````

.howToCodeWell{
   display:block
}

Or ````js ````

const website = howtocodewell.net
const podcast = howtocodewell.fm

console.log(website)
console.log(podcast)
  1. To create a new line hold down shift and press enter. Holding the shift key will prevent the message from being sent and it will put your cursor on the next line.

About

A template for asking questions in the How To Code Well discord server

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published