From 050995deea3962cbc0e21bb3ace4ccadf49ac51a Mon Sep 17 00:00:00 2001 From: "julian.mora" Date: Sun, 2 Dec 2018 11:34:27 -0500 Subject: [PATCH] Updated code of conduct, contributing and readme --- .gitattributes | 2 ++ .yo-rc.json | 8 +++++ README.md | 31 +++++++++++-------- code-of-conduct.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++ contributing.md | 41 +++++++++++-------------- package.json | 3 +- 6 files changed, 121 insertions(+), 38 deletions(-) create mode 100644 .gitattributes create mode 100644 .yo-rc.json create mode 100644 code-of-conduct.md diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..9e25297 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +* text=auto +readme.md merge=union diff --git a/.yo-rc.json b/.yo-rc.json new file mode 100644 index 0000000..d2b43ff --- /dev/null +++ b/.yo-rc.json @@ -0,0 +1,8 @@ +{ + "generator-awesome-list": { + "promptValues": { + "username": "juliandavidmr", + "email": "anlijudavid@hotmail.com" + } + } +} \ No newline at end of file diff --git a/README.md b/README.md index ff4de99..b36cab1 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,18 @@ -

- Awesome +
+ Awesome
-
- Awesome Nest -
-

+

Awesome Nest

-

- Resources + Resources     - Contribution guide + Contribution guide     - Official documentation -

+ Official documentation -
+ + Awesome + + ## Contents @@ -136,6 +134,13 @@ - [CLI](https://github.com/nestjs/nest-cli) - CLI tool for Nestjs applications. - [Yeoman Generator](https://github.com/ashinzekene/generator-nestjs-app) - A yeoman generator for nestsjs apps. +## Contribute + +Contributions welcome! Read the [contribution guidelines](contributing.md) first. + ## License -CC0 +[![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](http://creativecommons.org/publicdomain/zero/1.0) + +To the extent possible under law, juliandavidmr has waived all copyright and +related or neighboring rights to this work. diff --git a/code-of-conduct.md b/code-of-conduct.md new file mode 100644 index 0000000..14988cf --- /dev/null +++ b/code-of-conduct.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at anlijudavid@hotmail.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/contributing.md b/contributing.md index 05224a9..494aec7 100644 --- a/contributing.md +++ b/contributing.md @@ -1,32 +1,25 @@ -# Contributing Guide +# Contribution Guidelines -1. Make sure you put things in the right category! -2. Always add your items to the end of a list. To be fair, the order is first-come-first-serve. -3. If you think something belongs in the wrong category, or think there needs to be a new category, feel free to edit things too. +Please note that this project is released with a +[Contributor Code of Conduct](code-of-conduct.md). By participating in this +project you agree to abide by its terms. -## Projects using Nest +--- -Make sure you put things in the right category. There are two main categories: +Ensure your pull request adheres to the following guidelines: -- Open Source -- Apps/Websites/Tutorials +- Make sure you take care of this +- And this as well +- And don't forget to check this -## Open source +Thank you for your suggestions! -Open Source section gives the possibility for developers to contribute and be a part of an opensource project using their knowledge of the NestJS. -You should put your project in this category if the following conditions are true: -- The documentation (README) contains a description of the project, illustration of the project with a demo or screenshots and a CONTRIBUTING section. -- The project is active and maintained. -- The project accepts contributions. +## Updating your PR -The link provided should be the link of the github repository, not the demo. -If you consider your project finished, and it does not need any contributions, consider the apps/website/tutorial category. - -### Apps/Websites/Tutorials - -Apps/Websites gives the opportunity to showcase the awesome things we can build with Nest. -You should put your app/website/tutorial in this category if the following conditions are true: - -- The website is available without errors or ssl certificate problems, and load in a reasonable amount of time. -- The tutorial is public domain. +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. diff --git a/package.json b/package.json index 61be6d5..79f3433 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "awesome-nestjs", "version": "1.0.0", "description": "😏 Curated list of NestJS", + "private": false, "main": "index.js", "scripts": { "test": "awesome-lint" @@ -17,7 +18,7 @@ "node" ], "author": "https://github.com/juliandavidmr", - "license": "MIT", + "license": "CC0-1.0", "bugs": { "url": "https://github.com/juliandavidmr/awesome-nestjs/issues" },