An open API service indexing awesome lists of open source software.

https://github.com/cake-contrib/cakecontrib.guidelines

Adds common guidelines to cake-contrib projects
https://github.com/cake-contrib/cakecontrib.guidelines

cake-build hacktoberfest

Last synced: 6 months ago
JSON representation

Adds common guidelines to cake-contrib projects

Awesome Lists containing this project

README

          

# CakeContrib.Guidelines

[![standard-readme compliant][]][standard-readme]
[![All Contributors][all-contributors-badge]](#contributors)
[![Contributor Covenant][contrib-covenantimg]][contrib-covenant]
[![Build][build-badge]][build]
[![NuGet package][nugetimage]][nuget]

Adds common guidelines to cake-contrib projects

## Table of Contents

- [Install](#install)
- [Guidelines](#guidelines)
- [Discussion](#discussion)
- [Maintainer](#maintainer)
- [Contributing](#contributing)
- [Contributors](#contributors)
- [License](#license)

## Install

use one of the following:
```ps1
Install-Package CakeContrib.Guidelines
dotnet add package CakeContrib.Guidelines
paket add CakeContrib.Guidelines

```

or add the `PackageReference` manually
```

```

See [NuGet](https://www.nuget.org/packages/CakeContrib.Guidelines/) for the current version.

CakeContrib.Guidelines requires the use of `msbuild` version 16.8.0 or later.

## Guidelines

All [guidelines](https://cake-contrib.github.io/CakeContrib.Guidelines/guidelines) and [rules](https://cake-contrib.github.io/CakeContrib.Guidelines/rules) are documented at

## Discussion

If you have questions, search for an existing one, or create a new discussion on the Cake GitHub repository, using the `extension-q-a` category.

[![Join in the discussion on the Cake repository](https://img.shields.io/badge/GitHub-Discussions-green?logo=github)](https://github.com/cake-build/cake/discussions)

## Maintainer

[Nils Andresen @nils-a][maintainer]

## Contributing

CakeContrib.Guidelines follows the [Contributor Covenant][contrib-covenant] Code of Conduct.

We accept Pull Requests.
Please see [the contributing file][contributing] for how to contribute to CakeContrib.Guidelines.

Small note: If editing the Readme, please conform to the [standard-readme][] specification.

This project follows the [all-contributors][] specification. Contributions of any kind welcome!

### Contributors

Thanks goes to these wonderful people ([emoji key][emoji-key]):



Kim J. Nordmo
Kim J. Nordmo

💬 🤔
Jericho
Jericho

🐛 🤔
Nils Andresen
Nils Andresen

💻 🚧
C. Augusto Proiete
C. Augusto Proiete

🤔 👀
DiDoHH
DiDoHH

📖
Joel Ahlgren
Joel Ahlgren

💻
Mattias Karlsson
Mattias Karlsson

🐛

## License

[MIT License © Nils Andresen][license]

[all-contributors]: https://github.com/all-contributors/all-contributors
[all-contributors-badge]: https://img.shields.io/github/all-contributors/cake-contrib/CakeContrib.Guidelines/develop?&style=flat-square
[build]: https://github.com/cake-contrib/CakeContrib.Guidelines/actions/workflows/build.yml
[build-badge]: https://github.com/cake-contrib/CakeContrib.Guidelines/actions/workflows/build.yml/badge.svg
[contrib-covenant]: https://www.contributor-covenant.org/version/2/0/code_of_conduct/
[contrib-covenantimg]: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
[contributing]: CONTRIBUTING.md
[emoji-key]: https://allcontributors.org/docs/en/emoji-key
[maintainer]: https://github.com/nils-a
[nuget]: https://nuget.org/packages/CakeContrib.Guidelines
[nugetimage]: https://img.shields.io/nuget/v/CakeContrib.Guidelines.svg?logo=nuget&style=flat-square
[license]: LICENSE.txt
[standard-readme]: https://github.com/RichardLitt/standard-readme
[standard-readme compliant]: https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square