awesome_yourls/CONTRIBUTING.md

41 lines
2.2 KiB
Markdown
Raw Normal View History

2017-11-29 04:47:52 +00:00
# Contribution Guidelines
2021-02-21 18:14:15 +00:00
Do you want to get your work featured here, be it an article, plugin or other code ? You're at the right place.
2021-05-16 19:30:31 +00:00
Did you Notice something missing in this curated list of awesome things related to YOURLS ? Or encountered a dead link ?
2021-02-21 18:14:15 +00:00
## Open a pull request or file an issue in this repository
2021-05-16 19:30:31 +00:00
The best and fastest way is to open a pull request to add, fix or remove links.
2021-02-21 18:14:15 +00:00
2021-05-16 19:30:31 +00:00
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.
2017-11-29 04:47:52 +00:00
2021-02-21 18:14:15 +00:00
Any content, free or commercial, is welcome to be listed. Just make it clear to users.
2017-11-29 04:47:52 +00:00
2021-02-21 18:14:15 +00:00
## Show off to your users
2017-11-29 04:47:52 +00:00
2021-05-16 19:30:31 +00:00
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
2017-11-29 04:47:52 +00:00
2021-02-21 18:14:15 +00:00
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.
2017-11-29 04:47:52 +00:00
2021-05-16 19:30:31 +00:00
* [![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/)
```
2017-11-29 04:47:52 +00:00
2021-05-16 19:30:31 +00:00
* [![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/)
```
2021-02-21 18:14:15 +00:00
2021-05-16 19:30:31 +00:00
* [![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/)
2021-02-21 18:14:15 +00:00
```
## Code of Conduct
Please note that this project is released with a
2021-05-16 19:30:31 +00:00
[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.
2017-11-29 04:47:52 +00:00