-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Josh Goldberg ✨ <[email protected]>
- Loading branch information
1 parent
313e108
commit fff1cb1
Showing
5 changed files
with
174 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Code of Conduct | ||
|
||
"We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, ethnicity, religion, level of experience, or any other aspect of life. We expect anyone contributing to the Yeoman project to do the same." | ||
|
||
All contributions to this project are valuable, including and not limited to posting issues, updating documentation, submitting pull requests and providing feedback in comments. Please act with respect and avoid demeaning, condescending, racist, sexist and other inappropriate language and conduct. | ||
|
||
Please ensure comments stay professional, constructive and about the code, not the person. | ||
|
||
[![xkcd comic 1053](xkcd-1053.png)](http://xkcd.com/1053/) | ||
|
||
This Code of Conduct applies to all of the projects under the [Yeoman organization](https://github.com/yeoman) on GitHub and the Yeoman community at large (Discord, mailing lists, social media, etc.). | ||
|
||
See the [contributing guidelines](http://yeoman.io/contributing/) and the [tutorial on getting started with Yeoman](http://yeoman.io/learning/) for technical details of contributing to Yeoman or its satellite projects. | ||
|
||
## Events | ||
|
||
Any organizer running a Yeoman hackathon, meet-up, conference, user group, or other type of event is encouraged to adopt and provide an appropriate Code of Conduct. The [confcodeofconduct.com](http://confcodeofconduct.com) template is a good starting point. Participants should also have easy access to contact information that will allow them to privately get help or report violations of the Code of Conduct. | ||
|
||
For more on adopting a code of conduct, see [Ashe Dryden's FAQ](http://ashedryden.com/blog/codes-of-conduct-101-faq_). | ||
|
||
## Contribute to the Code of Conduct | ||
|
||
If you have suggestions to improve this Code of Conduct, please submit an issue or pull request. | ||
|
||
### How to Submit An Issue | ||
|
||
To submit an issue, simply click the Issues tab in the far right menu, below the <> Code tab. | ||
|
||
On the far right of that screen is a big green button that says "New Issue". Click the button and it will take you to a screen like this: | ||
|
||
Please make the Title of your issue "Code of Conduct Content Update" | ||
|
||
Issues will be reviewed by the Yeoman core team. This is standard for the GitHub workflow, which works primarily to serve code reviews. Any delay in time between your request and its addition to the Code of Conduct is not an indication it has been received negatively. | ||
|
||
Please note that some edits may be made to your suggestion, and this is also standard for the open source community and GitHub workflows. | ||
|
||
We welcome your thoughts and contributions. | ||
|
||
## Consequences for violations to this Code of Conduct | ||
|
||
If a participant engages in any behaviour violating this code of conduct, the core members of this community may take any action they deem appropriate, including warning the offender or expulsion from the community, exclusion from any interaction and loss of all rights in this community. | ||
|
||
## Reporting violations of the Code of Conduct | ||
|
||
If you personally require help or you are witness to violations of the Code of Conduct, please immediately contact [Any Core Team Member](https://github.com/yeoman/yeoman/#team). | ||
|
||
## Credits | ||
|
||
Based on the [Contributor Covenant by Coraline Ada Ehmke (Bantik)](https://github.com/Bantik/contributor_covenant), [AngularJS Code of Conduct](https://github.com/angular/code-of-conduct) (direct quote in first paragraph), [Hoodie Code of Conduct](http://hood.ie/code-of-conduct.html) (direct quote in "Consequences") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Contributing | ||
|
||
We are more than happy to accept external contributions to the project in the form of feedback, bug reports and even better - pull requests :) | ||
|
||
|
||
## Issue submission | ||
|
||
In order for us to help you please check that you've completed the following steps: | ||
|
||
* Made sure you're on the latest version `npm update -g yo` | ||
* Used the search feature to ensure that the bug hasn't been reported before | ||
* Included as much information about the bug as possible, including any output you've received, what OS and version you're on, etc. | ||
* Shared the output from running the following command in your project root as this can also help track down the issue. | ||
|
||
Unix: `yo --version && echo $PATH $NODE_PATH && node -e 'console.log(process.platform, process.versions)'` | ||
|
||
Windows (cmd.exe): `yo --version && echo %PATH% %NODE_PATH% && node -e "console.log(process.platform, process.versions)"` | ||
|
||
Windows (PowerShell): `yo --version; echo %PATH% %NODE_PATH%; node -e "console.log(process.platform, process.versions)"` | ||
|
||
[Submit your issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-an-issue) | ||
|
||
|
||
## Quick Start | ||
|
||
- Clone the repo of [yo](https://github.com/yeoman/yo), [generator](https://github.com/yeoman/generator), and any generator you might want to develop against, and then run `npm install` in them. | ||
- Go to the yo folder and link it globally using `npm link` then link in the generators using `npm link path/to/generator` for each. | ||
- Run `yo` and you should now see the linked generators in the list. | ||
- Start hacking :) | ||
|
||
You can keep the various repos up to date by running `git pull --rebase upstream master` in each. | ||
|
||
|
||
## Style Guide | ||
|
||
This project uses single-quotes, two space indentation, multiple var statements and whitespace around arguments. Use a single space after keywords like `function`. Ex: | ||
|
||
``` | ||
function () { ... } | ||
function foo() { ... } | ||
``` | ||
|
||
Please ensure any pull requests follow this closely. If you notice existing code which doesn't follow these practices, feel free to shout and we will address this. | ||
|
||
|
||
## Pull Request Guidelines | ||
|
||
* Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned. We also recommend checking for issues related to the issue on the tracker, as a team member may be working on the issue in a branch or fork. | ||
* Non-trivial changes should be discussed in an issue first | ||
* Develop in a topic branch, not master | ||
* Add relevant tests to cover the change | ||
* Make sure test-suite passes: `npm test` | ||
* Lint the code (mostly done with running the tests) | ||
* Squash your commits | ||
* Write a convincing description of your PR and why we should land it | ||
* Check the individual project to see if there is a **contributing.md** or similar file as some project's have different requirements. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
<!-- | ||
Allo' allo'! | ||
Thanks for taking the time to submit an issue. | ||
Please keep in mind, that GitHub issues are meant to be used for reporting bugs and to | ||
request new features. | ||
Use Stack Overflow for support: http://stackoverflow.com/questions/tagged/yeoman | ||
Head over to our Discord (https://discord.gg/tKnYVm4k) and ask for help in its [`#help` channel](https://discord.com/channels/1326978160515879063/1327268999817334884) if you’re unsure if you ran into a bug or if you have any other question. | ||
You would like to report a bug? | ||
Use the search feature to ensure that the bug hasn't been reported before. | ||
Please ensure to provide the following information to make sure we have all we need to address your issue. | ||
--> | ||
|
||
## Type of issue | ||
|
||
<!-- Feature request or bug --> | ||
|
||
<!-- Please delete the rest of the template in case of a feature request --> | ||
|
||
---- | ||
|
||
## My environment | ||
|
||
* *OS version/details*: `eg. Windows 10 64-bit` | ||
* *Node version:* `x.x.x` (run `node --version` in your terminal) | ||
* *npm version:* `x.x.x` (run `npm --version` in your terminal) | ||
* *Version of yo :* `x.x.x` (run `yo --version` in your terminal) | ||
|
||
## Expected behavior | ||
|
||
<!-- Description over here --> | ||
|
||
## Current behavior | ||
|
||
<!-- Description over here --> | ||
|
||
## Steps to reproduce the behavior | ||
|
||
## Command line output | ||
|
||
``` | ||
Paste your error output over here | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- | ||
Allo' allo'! | ||
Thanks for taking the time to submit a pull request ❤ | ||
Please make sure you read and fulfill our pull request guidelines: | ||
https://github.com/yeoman/.github/blob/master/.github/contributing.md | ||
Additional useful information is placed on the Yeoman Website: | ||
http://yeoman.io/contributing/pull-request.html | ||
--> | ||
|
||
## Purpose of this pull request? | ||
|
||
- [ ] Documentation update | ||
- [ ] Bug fix | ||
- [ ] Enhancement | ||
- [ ] Other, please explain: | ||
|
||
## What changes did you make? | ||
|
||
<!-- Give an overview --> | ||
|
||
## Is there anything you'd like reviewers to focus on? | ||
|
||
<!-- Just in case --> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.