-
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.
add my own readme so i'm not a jerk, add CoC, TBD contributing
- Loading branch information
1 parent
8eac7c9
commit c0dad6b
Showing
3 changed files
with
122 additions
and
17 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,76 @@ | ||
# 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, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, 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 [INSERT EMAIL ADDRESS]. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
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,3 @@ | ||
# Contributing | ||
|
||
_TBD_ |
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 |
---|---|---|
@@ -1,36 +1,62 @@ | ||
# generator-standard-docs-templates [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] | ||
# generator-standard-docs-templates | ||
|
||
> A generator that creates standard templates for common repository documentation. | ||
## Installation | ||
To make it easy for engineers on your team to do the right thing and write great documentation, this package generates standard documentation templates. Using a Yeoman generator CLI, you can answer questions to get a pre-filled README and other documentation. | ||
|
||
* **README** — As the entry point to the tool, a good README should explain what the tool is, how to use and install it, and how to get in touch with maintainers. A standard README template makes it easy for consumers to find the information they need. | ||
* **CONTRIBUTING** — Contributing information helps turn consumers into collaborators, by describing how to install, contribute, code review, and participate in the tool's development. | ||
* **CHANGELOG** — A changelog, both automatically generated and human-augmented, helps consumers understand the changes between versions. A changelog is a crucial part of understanding how to upgrade. | ||
* **CODE_OF_CONDUCT** — Based on the [Contributor Covenant](https://www.contributor-covenant.org/), a code of conduct governs how we interact with contributors to our projects. | ||
* **LICENSE** — Optional, but useful if you want your project to be shared and used. A license is required for many organizations to use OS projects. | ||
|
||
## Table of Contents | ||
|
||
First, install [Yeoman](http://yeoman.io) and generator-standard-docs-templates using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)). | ||
* [Install](#install) | ||
* [Usage](#usage) | ||
* [Releases](#releases) | ||
* [Maintainers](#maintainers) | ||
* [Contributing](#contributing) | ||
* [License](#license) | ||
|
||
## Install | ||
First install [Yeoman](https://yeoman.io), and this package, with npm: | ||
|
||
```bash | ||
npm install -g yo | ||
npm install -g generator-standard-docs-templates | ||
``` | ||
|
||
Then generate your new project: | ||
Then to run the generator: | ||
|
||
```bash | ||
yo standard-docs-templates | ||
``` | ||
|
||
## Getting To Know Yeoman | ||
### Prerequisites | ||
Requires [Node](https://nodejs.org), [npm](https://www.npmjs.com), and [Yeoman](https://yeoman.io). | ||
|
||
* Yeoman has a heart of gold. | ||
* Yeoman is a person with feelings and opinions, but is very easy to work with. | ||
* Yeoman can be too opinionated at times but is easily convinced not to be. | ||
* Feel free to [learn more about Yeoman](http://yeoman.io/). | ||
## Usage | ||
_TBD_ | ||
|
||
## License | ||
### CLI | ||
_TBD_ | ||
|
||
MIT © [Elyse Holladay]() | ||
## Releases | ||
This project follows [Semantic Versioning](https://semver.org/). Release versions can be found on the [Releases page](https://github.com/elyseholladay/generator-standard-docs-templates/releases). | ||
|
||
## Maintainers | ||
* [Elyse Holladay](https://github.com/elyseholladay) | ||
|
||
[npm-image]: https://badge.fury.io/js/generator-standard-docs-templates.svg | ||
[npm-url]: https://npmjs.org/package/generator-standard-docs-templates | ||
[travis-image]: https://travis-ci.org/elyseholladay/generator-standard-docs-templates.svg?branch=master | ||
[travis-url]: https://travis-ci.org/elyseholladay/generator-standard-docs-templates | ||
[daviddm-image]: https://david-dm.org/elyseholladay/generator-standard-docs-templates.svg?theme=shields.io | ||
[daviddm-url]: https://david-dm.org/elyseholladay/generator-standard-docs-templates | ||
## Contributing | ||
Contributions and PRs are accepted on this project. | ||
|
||
Please read the [CONTRIBUTING.md](CONTRIBUTING.md) for information on how to contribute. | ||
|
||
`this-project` is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
||
### Local Development | ||
_TBD_ | ||
|
||
## License | ||
`this-project` is licensed under the [MIT License](LICENSE). |