https://github.com/simonv3/covenant-generator

`covgen` generates a code of conduct.
https://github.com/simonv3/covenant-generator

code-of-conduct contributors-covenant covenant covenant-generator documentation markdown

Last synced: 21 days ago
JSON representation

`covgen` generates a code of conduct.

• Host: GitHub
• URL: https://github.com/simonv3/covenant-generator
• Owner: simonv3
• License: mit
• Created: 2015-11-03T21:47:01.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2021-08-21T18:08:24.000Z (over 3 years ago)
• Last Synced: 2024-12-25T00:00:46.349Z (about 1 month ago)
• Topics: code-of-conduct, contributors-covenant, covenant, covenant-generator, documentation, markdown
• Language: JavaScript
• Homepage:
• Size: 336 KB
• Stars: 47
• Watchers: 8
• Forks: 25
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Covenant Generator

[![Greenkeeper badge](https://badges.greenkeeper.io/simonv3/covenant-generator.svg)](https://greenkeeper.io/)

[![Build Status](https://api.travis-ci.org/simonv3/covenant-generator.svg?branch=master)](https://travis-ci.org/simonv3/covenant-generator)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fsimonv3%2Fcovenant-generator.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fsimonv3%2Fcovenant-generator?ref=badge_shield)

## Install

```

npm install -g covgen

```

## Usage

And then in your new projects:

```

covgen 

```

Generates the [Contributor Covenant](http://contributor-covenant.org/) inside the current directory.

You can also specify where the file goes:

```

covgen  destination.md

```

Or, for multiple locations, use commas to delimit locations

```

covgen  destination.md,newDirectory/second_destination.md

```

If you don't specify an email address, it will use the email found in `~/.gitconfig`.

Warning! Just copy and pasting a code of conduct isn't a fix. You have to live by it.

I've made this project because the Contributor Covenant is a really good Code of Conduct to use as a standard and if you've read and will abide by it, it's a good default to include in your project.

The code of conduct in this repository was generated with covenant generator.

## Contribute

Sure! Take a look at the [Contributing file](CONTRIBUTING.md).

## License

[MIT](LICENSE)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fsimonv3%2Fcovenant-generator.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fsimonv3%2Fcovenant-generator?ref=badge_large)