1
0
Fork 0
mirror of https://github.com/vuejs/awesome-vue.git synced 2025-02-24 15:45:42 -05:00
vue/CONTRIBUTING.md

19 lines
806 B
Markdown
Raw Normal View History

2015-10-19 20:15:50 -04:00
# Contributing Guide
2016-06-23 15:11:55 +08:00
To add another awesome resource, simply create a `.md` file under an appropriate directory in `/awesomeness` with these contents:
``` yaml
---
name: Your Project Name
url: http://yourproject.io
author: "Your Name (http://yourhomepage.net)"
description: "[Markdown](https://daringfireball.net/projects/markdown/) is supported!"
tags:
- pure
- awesomess
```
The only mandatory information is `name`, though obviously, you're encouraged to fill in as much information as you can!
Note: Since the `.md` file actually uses YAML syntax and is parsed by a YAML parser, you'll need quotes if your content includes special characters, e.g. `:`, `{`, `}`, `[`, `]`, `,`, `&`, `*`, `#`, `?`, `|`, `-`, `<`, `>`, `=`, `!`, `%`, `@`, `\`. Or, to play it safe, just quote all the things™!