Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 1.14 KB
Raw

Welcome to the contributing guide

Thank you for considering contributing to Useful GitHub Flavored Markdown Snippets.

To contribute a useful snippet, create a pull request with your snippet.

The snippet should include the following:

  • A Title
  • A Description
  • Code example
  • Display example
  • Link to Source

Example snippet.

## Title

A small paragraph describing what the snippet does.

```md
> [!NOTE]
> This should contain an example of the useful snippet.
```

> [!NOTE]
> This should display the useful snippet given in the example.

Source: [Title of source](url-to-source)

Optionally the snippet can also include a checkbox, indicating if the functionality works on the GitHub mobile app.

Lastly, the snippet can also include an optional description if the user needs to do a step to view the functionality working, see Context Based Images as an example.