Updated code of conduct, contributing and readme

This commit is contained in:
julian.mora
2018-12-02 11:34:27 -05:00
parent cc5a430d80
commit 050995deea
6 changed files with 121 additions and 38 deletions
+2
View File
@@ -0,0 +1,2 @@
* text=auto
readme.md merge=union
+8
View File
@@ -0,0 +1,8 @@
{
"generator-awesome-list": {
"promptValues": {
"username": "juliandavidmr",
"email": "anlijudavid@hotmail.com"
}
}
}
+18 -13
View File
@@ -1,20 +1,18 @@
<h1 align="center">
<img width="250" src="https://camo.githubusercontent.com/18fe3feea5e3593c593e12e552494a3995eceacf/687474703a2f2f6b616d696c6d79736c69776965632e636f6d2f7075626c69632f6e6573742d6c6f676f2e706e672331" alt="Awesome">
<div align="center">
<img width="250" src="https://camo.githubusercontent.com/18fe3feea5e3593c593e12e552494a3995eceacf/687474703a2f2f6b616d696c6d79736c69776965632e636f6d2f7075626c69632f6e6573742d6c6f676f2e706e672331" alt="Awesome">
<br>
<center>
<strong>Awesome Nest</strong>
</center>
</h1>
<h1>Awesome Nest</h1>
<p align="center">
<a href="#resources">Resources</a>
<a href="#resources">Resources</a>
&nbsp;&nbsp;&nbsp;
<a href="contributing.md">Contribution guide</a>
<a href="contributing.md">Contribution guide</a>
&nbsp;&nbsp;&nbsp;
<a href="https://nestjs.com">Official documentation</a>
</p>
<a href="https://nestjs.com">Official documentation</a>
<br>
<a href="https://awesome.re">
<img src="https://awesome.re/badge.svg" alt="Awesome">
</a>
</div>
## 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
<a href="https://creativecommons.org/publicdomain/zero/1.0/"><img src="https://camo.githubusercontent.com/da896acd40e1f4f275c2da6e1d830b2865803fc8/68747470733a2f2f692e6372656174697665636f6d6d6f6e732e6f72672f702f7a65726f2f312e302f38387833312e706e67" alt="CC0" data-canonical-src="https://i.creativecommons.org/p/zero/1.0/88x31.png" style="max-width:100%;"></a>
[![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.
+74
View File
@@ -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/
+17 -24
View File
@@ -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.
+2 -1
View File
@@ -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"
},