diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f7bfe8..52dcea8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,36 +1,40 @@ # Contribution Guidelines -Did you Notice something missing in this curated list of awesome things related to YOURLS ? Or encountered a dead link ? - Do you want to get your work featured here, be it an article, plugin or other code ? You're at the right place. +Did you Notice something missing in this curated list of awesome things related to YOURLS ? Or encountered a dead link ? + ## Open a pull request or file an issue in this repository -The best and fastest way is to open a pull request to add, fix or remove links. A slowest alternative is to open an issue. +The best and fastest way is to open a pull request to add, fix or remove links. -Please prefer hosting your resources (code, article) somewhere users will be able to interact with you (blog comments, Github issues). This way, official YOURLS resources won't be polluted by questions concerning your material. +Please prefer hosting your resources (code, article) somewhere users will be able to interact with you (blog comments, ideally Github issues). This way, official YOURLS resources won't be polluted by questions concerning your material. Any content, free or commercial, is welcome to be listed. Just make it clear to users. ## Show off to your users -On your `readme` or home page, make sure your users notice that you are listed on this awesome list. This way the community will grow faster and you will eventually get more users +On your `README` or home page, make sure your users notice that you are listed on this awesome list. This way the community will grow faster and you will eventually get more users It's totally optional, but it's a nice way to show you've been featured in an Awesome list. You can choose either the regular badge or the flat one. -[![Mentioned in Awesome](https://awesome.re/mentioned-badge.svg)](https://github.com/YOURLS/awesome-yourls/) -[![Mentioned in Awesome](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/YOURLS/awesome-yourls/) +* [![Listed in Awesome YOURLS!](https://img.shields.io/badge/Awesome-YOURLS-C5A3BE)](https://github.com/YOURLS/awesome-yourls/) +``` +[![Listed in Awesome YOURLS!](https://img.shields.io/badge/Awesome-YOURLS-C5A3BE)](https://github.com/YOURLS/awesome-yourls/) +``` -**Fill in the placeholders (Name and URL):** +* [![Listed in Awesome YOURLS!](https://img.shields.io/static/v1?label=Awesome&message=YOURLS&color=C5A3BE&style=plastic)](https://github.com/YOURLS/awesome-yourls/) +``` +[![Listed in Awesome YOURLS!](https://img.shields.io/static/v1?label=Awesome&message=YOURLS&color=C5A3BE&style=plastic)](https://github.com/YOURLS/awesome-yourls/) +``` -```md -[![Mentioned in Awesome YOURLS](https://awesome.re/mentioned-badge.svg)](https://github.com/YOURLS/awesome-yourls/) -[![Mentioned in Awesome YOURLS](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/YOURLS/awesome-yourls/) +* [![Listed in Awesome YOURLS!](https://img.shields.io/static/v1?label=Awesome&message=YOURLS&color=C5A3BE&style=flat-square)](https://github.com/YOURLS/awesome-yourls/) +``` +[![Listed in Awesome YOURLS!](https://img.shields.io/static/v1?label=Awesome&message=YOURLS&color=C5A3BE&style=flat-square)](https://github.com/YOURLS/awesome-yourls/) ``` ## Code of Conduct Please note that this project is released with a -[Contributor Code of Conduct](https://github.com/YOURLS/.github/blob/master/CODE_OF_CONDUCT.md). By participating in this -project you agree to abide by its terms. +[Contributor Code of Conduct](https://github.com/YOURLS/.github/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.