Awesome-Mirrors/awesome-markdown
1
0
Fork 0
mirror of https://github.com/BubuAnabelas/awesome-markdown.git synced 2024-10-01 01:06:15 -04:00
Code Issues Packages Projects Releases Wiki Activity

Comply with the community standards adding a pull request template.

Browse Source
This commit is contained in:
BubuAnabelas 2018-01-06 17:47:11 -03:00
parent 3bbcd3f15b
commit 2fd31ec16c
3 changed files with 35 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
code-of-conduct.md → .github/code-of-conduct.md vendored
View File

15
contributing.md → .github/contributing.md vendored
View File

@ -4,9 +4,9 @@ Ensure your pull request adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate. - Search previous suggestions before making a new one, as yours may be a duplicate.
- Make an individual pull request for each suggestion. - Make an individual pull request for each suggestion.
- Use the following format: `[name](link) - Description.` - Use the following format: `[PROJECT](LINK) - DESCRIPTION.`
- Links must use `https` when possible. - Links must use `https` when possible.
- Additions should mantain the alphabeticall order in the category. - Additions should mantain the alphabetical order in the category.
- New categories, or improvements to the existing categorization are welcome. - New categories, or improvements to the existing categorization are welcome.
- Keep descriptions short and simple, but descriptive. - Keep descriptions short and simple, but descriptive.
- Start the description with a capital and end with a full stop/period. - Start the description with a capital and end with a full stop/period.
@ -19,3 +19,14 @@ Thank you for your suggestion!
### Updating your PR ### 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. If you're not sure how to do that, [here is a guide](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) on the different ways you can update your PR so that we can merge it. 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. If you're not sure how to do that, [here is a guide](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) on the different ways you can update your PR so that we can merge it.
#### Deleting
Typical reasons for deleting project:
- No updates / no longer works.
- Deprecated.
- Lacks license.
Your contributions are always welcome!
Thank you for your suggestions!

21
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,21 @@
<!--- Provide a general summary of your changes in the Title above -->
## Project URL
<!--- The project URL -->
## Category
<!--- Category in the list where the project will be added -->
## Description
<!--- Describe your changes in detail -->
## Why it should be included to `awesome-markdown` (optional)
## Checklist
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] Only one project/change is in this pull request
- [ ] Addition in alphabetical order
- [ ] Has a commit from less than 2 years ago
- [ ] Has a **clear** README in English