beenull/awesome_yourls
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
྅༻ Ǭɀħ ༄༆ཉ 2021-02-21 19:14:15 +01:00 committed by GitHub
parent b8f933e507
commit fdde964ab3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
CONTRIBUTING.md
View file

@ -1,25 +1,36 @@
# 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.
## 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.
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.
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
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/)
**Fill in the placeholders (Name and URL):**
```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/)
```
## 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.
---
Ensure your pull request adheres to the following guidelines:
- Make sure you take care of this
- And this as well
- And don't forget to check this
Thank you for your suggestions!
## Updating your PR
A lot of times, making a PR adhere to the standards above can be difficult.
If the maintainers notice anything that we'd like changed, we'll ask you to
edit your PR before we merge it. There's no need to open a new PR, just edit
the existing one. If you're not sure how to do that,
[here is a guide](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md)
on the different ways you can update your PR so that we can merge it.