Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Mention `@` sign collisions

This happens a lot in discussions. Mentioning it might cut down on the amount of times we remind people.
  • Loading branch information...
commit f4662e425ef41718c104bdc8337234e28eeb1fa2 1 parent 28bf877
@sjkelly sjkelly authored
Showing with 1 addition and 1 deletion.
  1. +1 −1  CONTRIBUTING.md
View
2  CONTRIBUTING.md
@@ -34,7 +34,7 @@ A useful bug report filed as a Github issue provides information about how to re
- A minimal working example, i.e. the smallest chunk of code that triggers the error. Ideally, this should be code that can be pasted into a REPL or run from a source file. If the code is larger than (say) 50 lines, consider putting it in a [gist](https://gist.github.com).
- The version of Julia you are using as provided by the `versioninfo()` command. Occasionally, the longer output produced by `versioninfo(true)` may be useful also, especially if the issue is related to a specific package.
-4. When pasting code or output, put triple backquotes (```) around the code block and output block so that Github will format it nicely.
+4. When pasting code blocks or output, put triple backquotes (\`\`\`) around the text so Github will format it nicely. You can format code statements by surrounding it in single backquotes (\`). Be aware that the `@` sign tags users on GitHub, so references to macros should always be in single backquotes. See [GitHub's guide on Markdown](https://guides.github.com/features/mastering-markdown/) for more formatting tricks.
## Submitting your contributions
Please sign in to comment.
Something went wrong with that request. Please try again.