From 2fd31ec16cb81cd22173e0ec27a88e0379c43c31 Mon Sep 17 00:00:00 2001 From: BubuAnabelas Date: Sat, 6 Jan 2018 17:47:11 -0300 Subject: [PATCH] Comply with the community standards adding a pull request template. --- .../code-of-conduct.md | 0 contributing.md => .github/contributing.md | 17 ++++++++++++--- .github/pull_request_template.md | 21 +++++++++++++++++++ 3 files changed, 35 insertions(+), 3 deletions(-) rename code-of-conduct.md => .github/code-of-conduct.md (100%) rename contributing.md => .github/contributing.md (72%) create mode 100644 .github/pull_request_template.md diff --git a/code-of-conduct.md b/.github/code-of-conduct.md similarity index 100% rename from code-of-conduct.md rename to .github/code-of-conduct.md diff --git a/contributing.md b/.github/contributing.md similarity index 72% rename from contributing.md rename to .github/contributing.md index 1c06692..cd86909 100755 --- a/contributing.md +++ b/.github/contributing.md @@ -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. - 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. -- 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. - Keep descriptions short and simple, but descriptive. - Start the description with a capital and end with a full stop/period. @@ -18,4 +18,15 @@ Thank you for your suggestion! ### 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. \ No newline at end of file +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! diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..a09601c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,21 @@ + + +## Project URL + + +## Category + + +## Description + + +## Why it should be included to `awesome-markdown` (optional) + +## Checklist + + +- [ ] 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 +