Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 135 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# Contributor Covenant Code of Conduct

This document is adapted from the Contributor Covenant which is used by many open source projects,
including those under the [.NET Foundation](https://dotnetfoundation.org/code-of-conduct).

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
35 changes: 35 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing to Cuemon for .NET
When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

## Code of Conduct
Please review our [code of conduct](.github/CODE_OF_CONDUCT.md).

## Our Development Process
We use GitHub with a simple GitFlow inspired flow.
All new features and/or fixes are merged into the `development` branch by creating a Pull Request.

## Pull Requests
We actively welcome your pull requests.

1. Fork the repo and create your branch from `development`
2. If you've added code that should be tested, add tests (DO follow [Microsoft Engineering Guidelines](https://github.com/dotnet/aspnetcore/wiki/Engineering-guidelines))
3. Any changes or additions requires documentation in the form of documenting public members
4. Ensure that all existing as well as new test passes
5. Issue that pull request with a big and heartful thanks for contributing

## Issues
We use GitHub issues to track public bugs. Please ensure your description is
clear and has sufficient instructions to be able to reproduce the issue.

## Coding Guidelines
* Please follow Framework Design Guidelines
* Please follow SOLID principles
* Let yourself be inspired by [Microsoft Engineering Guidelines](https://github.com/dotnet/aspnetcore/wiki/Engineering-guidelines)
* Consider reading my short take on [Software craftsmanship - a journey with inspirational sources!](https://github.com/gimlichael/Must-Read-Resources)

## License
By contributing to Cuemon for .NET, you agree that your contributions will be licensed
under the MIT license.
115 changes: 78 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

# Cuemon for .NET

An open-source project (MIT license) that targets and complements the Microsoft .NET platform. It provides vast ways of possibilities for all breeds of coders, programmers, developers and the likes thereof. Ideal for .NET, .NET Standard, .NET Core, Universal Windows Platform and .NET Framework 4.6.1 and newer.
An open-source project (MIT license) that targets and complements the Microsoft .NET platform. It provides vast ways of possibilities for all breeds of coders, programmers, developers and the likes thereof.
Your ideal companion for .NET 5, .NET Core 3, .NET Core 2, .NET Standard 2.1, .NET Standard 2, Universal Windows Platform and .NET Framework 4.6.1 and newer.

It is, by heart, free, flexible and built to extend and boost your agile codebelt.

Expand All @@ -19,9 +20,9 @@ All CI and CD integrations are done on [Microsoft Azure DevOps](https://azure.mi

All code quality analysis are done by [SonarCloud](https://sonarcloud.io/) and [CodeCov.io](https://codecov.io/).

Currently work is done on ironing out the kinks in relations to NuGet package description, release notes conventions, concepts and last minute refactorings to provide the best experience possible with RC-1!
Currently work is done on ironing out the kinks in relations to NuGet package description, release notes conventions, concepts and last minute refactorings to provide the best experience possible with the RCs!

![License](https://img.shields.io/github/license/gimlichael/cuemon) [![Build Status](https://dev.azure.com/gimlichael/Cuemon/_apis/build/status/gimlichael.Cuemon?branchName=development)](https://dev.azure.com/gimlichael/Cuemon/_build/latest?definitionId=9&branchName=development) [![codecov](https://codecov.io/gh/gimlichael/Cuemon/branch/development/graph/badge.svg)](https://codecov.io/gh/gimlichael/Cuemon) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Cuemon&metric=coverage)](https://sonarcloud.io/dashboard?id=Cuemon)
![License](https://img.shields.io/github/license/gimlichael/cuemon) [![Build Status](https://dev.azure.com/gimlichael/Cuemon/_apis/build/status/gimlichael.Cuemon?branchName=development)](https://dev.azure.com/gimlichael/Cuemon/_build/latest?definitionId=9&branchName=development) [![codecov](https://codecov.io/gh/gimlichael/Cuemon/branch/development/graph/badge.svg)](https://codecov.io/gh/gimlichael/Cuemon) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Cuemon&metric=coverage)](https://sonarcloud.io/dashboard?id=Cuemon) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](.github/CODE_OF_CONDUCT.md)


## Development Branch
Expand Down Expand Up @@ -66,40 +67,80 @@ Builds performed from this repository are pushed to NuGet.org as the actual vers

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=Cuemon&metric=ncloc)](https://sonarcloud.io/dashboard?id=Cuemon) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Cuemon&metric=code_smells)](https://sonarcloud.io/dashboard?id=Cuemon) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=Cuemon&metric=sqale_index)](https://sonarcloud.io/dashboard?id=Cuemon) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Cuemon&metric=bugs)](https://sonarcloud.io/dashboard?id=Cuemon) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Cuemon&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=Cuemon) [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=Cuemon&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=Cuemon)

# Contributing to Cuemon for .NET

A big welcome and thank you for considering contributing to Cuemon for .NET open source project!

Please read more about [contributing to Cuemon for .NET](.github/CONTRIBUTING.md).

# Code of Conduct

Project maintainers pledge to foster an open and welcoming environment, and ask contributors to do the same.

For more information see our [code of conduct](.github/CODE_OF_CONDUCT.md).


## Links to NuGet packages (will be updated once Cuemon for .NET has shipped in 6.0.0)

NuGet links for this project:

* [Cuemon.AspNetCore](https://www.nuget.org/packages/Cuemon.AspNetCore/)
* [Cuemon.AspNetCore.Authentication](https://www.nuget.org/packages/Cuemon.AspNetCore.Authentication/)
* [Cuemon.AspNetCore.Mvc](https://www.nuget.org/packages/Cuemon.AspNetCore.Mvc/)
* ~~Cuemon.AspNetCore.Mvc.Formatters.Json~~
* ~~Cuemon.AspNetCore.Mvc.Formatters.Xml~~
* [Cuemon.AspNetCore.Razor.TagHelpers](https://www.nuget.org/packages/Cuemon.AspNetCore.Razor.TagHelpers/)
* ~~Cuemon.Collections.Specialized~~
* [Cuemon.Core](https://www.nuget.org/packages/Cuemon.Core/)
* [Cuemon.Data](https://www.nuget.org/packages/Cuemon.Data/)
* [Cuemon.Data.Integrity](https://www.nuget.org/packages/Cuemon.Data.Integrity/)
* [Cuemon.Data.SqlClient](https://www.nuget.org/packages/Cuemon.Data.SqlClient/)
* ~~Cuemon.Data.XmlClient~~
* [Cuemon.Diagnostics](https://www.nuget.org/packages/Cuemon.Diagnostics/)
* [Cuemon.Extensions.AspNetCore](https://www.nuget.org/packages/Cuemon.Extensions.AspNetCore/)
* [Cuemon.Extensions.AspNetCore.Authentication](https://www.nuget.org/packages/Cuemon.Extensions.AspNetCore.Authentication/)
* [Cuemon.Extensions.AspNetCore.Mvc](https://www.nuget.org/packages/Cuemon.Extensions.AspNetCore.Mvc/)
* [Cuemon.Extensions.AspNetCore.Mvc.Formatters.Newtonsoft.Json](https://www.nuget.org/packages/Cuemon.Extensions.AspNetCore.Mvc.Formatters.Newtonsoft.Json/)
* [Cuemon.Extensions.AspNetCore.Mvc.Formatters.Xml](https://www.nuget.org/packages/Cuemon.Extensions.AspNetCore.Mvc.Formatters.Xml/)
* [Cuemon.Extensions.Collections.Generic](https://www.nuget.org/packages/Cuemon.Extensions.Collections.Generic/)
* [Cuemon.Extensions.Collections.Specialized](https://www.nuget.org/packages/Cuemon.Extensions.Collections.Specialized/)
* [Cuemon.Extensions.Core](https://www.nuget.org/packages/Cuemon.Extensions.Core/)
* [Cuemon.Extensions.Data](https://www.nuget.org/packages/Cuemon.Extensions.Data/)
* [Cuemon.Extensions.Data.Integrity](https://www.nuget.org/packages/Cuemon.Extensions.Data.Integrity/)
* [Cuemon.Extensions.DependencyInjection](https://www.nuget.org/packages/Cuemon.Extensions.DependencyInjection/)
* [Cuemon.Extensions.Diagnostics](https://www.nuget.org/packages/Cuemon.Extensions.Diagnostics/)
* [Cuemon.Extensions.Hosting](https://www.nuget.org/packages/Cuemon.Extensions.Hosting/)
* [Cuemon.Extensions.IO](https://www.nuget.org/packages/Cuemon.Extensions.IO/)
* [Cuemon.Extensions.Net](https://www.nuget.org/packages/Cuemon.Extensions.Net/)
* [Cuemon.Extensions.Newtonsoft.Json](https://www.nuget.org/packages/Cuemon.Extensions.Newtonsoft.Json/)
* [Cuemon.Extensions.Reflection](https://www.nuget.org/packages/Cuemon.Extensions.Reflection/)
* [Cuemon.Extensions.Runtime.Caching](https://www.nuget.org/packages/Cuemon.Extensions.Runtime.Caching/)
* [Cuemon.Extensions.Text](https://www.nuget.org/packages/Cuemon.Extensions.Text/)
* [Cuemon.Extensions.Threading](https://www.nuget.org/packages/Cuemon.Extensions.Threading/)
* [Cuemon.Extensions.Xml](https://www.nuget.org/packages/Cuemon.Extensions.Xml/)
* [Cuemon.Extensions.Xunit](https://www.nuget.org/packages/Cuemon.Extensions.Xunit/)
* [Cuemon.Extensions.Xunit.Hosting](https://www.nuget.org/packages/Cuemon.Extensions.Xunit.Hosting/)
* [Cuemon.Extensions.Xunit.Hosting.AspNetCore](https://www.nuget.org/packages/Cuemon.Extensions.Xunit.Hosting.AspNetCore/)
* [Cuemon.Extensions.Xunit.Hosting.AspNetCore.Mvc](https://www.nuget.org/packages/Cuemon.Extensions.Xunit.Hosting.AspNetCore.Mvc/)
* ~~Cuemon.Integrity~~
* [Cuemon.IO](https://www.nuget.org/packages/Cuemon.IO/)
* [Cuemon.Net](https://www.nuget.org/packages/Cuemon.Net/)
* ~~Cuemon.Net.Mail~~
* ~~Cuemon.Reflection~~
* [Cuemon.Resilience](https://www.nuget.org/packages/Cuemon.Resilience/)
* ~~Cuemon.Runtime~~
* [Cuemon.Runtime.Caching](https://www.nuget.org/packages/Cuemon.Runtime.Caching/)
* ~~Cuemon.Security~~
* [Cuemon.Security.Cryptography](https://www.nuget.org/packages/Cuemon.Security.Cryptography/)
* ~~Cuemon.Serialization~~
* ~~Cuemon.Serialization.Json~~
* ~~Cuemon.Serialization.Xml~~
* [Cuemon.Threading](https://www.nuget.org/packages/Cuemon.Threading/)
* ~~Cuemon.Web~~
* [Cuemon.Xml](https://www.nuget.org/packages/Cuemon.Xml/)


These will be updated to the current version ASAP to get you started out easy.


### Links to NuGet packages (will be updated once Cuemon for .NET has shipped in 6.0.0)

Useful links for this project (will soon be changed for the forthcoming release):

* [Cuemon .NET Standard](http://www.cuemon.net/)
* Cuemon .NET Standard Package on [Nuget](https://www.nuget.org/packages/Cuemon.Core.Package/)
* Cuemon ASP.NET Core Package on [Nuget](https://www.nuget.org/packages/Cuemon.AspNetCore.Package/)
* Cuemon.AspNetCore on [Nuget](https://www.nuget.org/packages/Cuemon.AspNetCore/)
* Cuemon.AspNetCore.Authentication on [Nuget](https://www.nuget.org/packages/Cuemon.AspNetCore.Authentication/)
* Cuemon.AspNetCore.Mvc on [Nuget](https://www.nuget.org/packages/Cuemon.AspNetCore.Mvc/)
* Cuemon.AspNetCore.Mvc.Formatters.Json on [Nuget](https://www.nuget.org/packages/Cuemon.AspNetCore.Mvc.Formatters.Json/)
* Cuemon.AspNetCore.Mvc.Formatters.Xml on [Nuget](https://www.nuget.org/packages/Cuemon.AspNetCore.Mvc.Formatters.Xml/)
* Cuemon.Collections.Specialized on [Nuget](https://www.nuget.org/packages/Cuemon.Collections.Specialized/)
* Cuemon.Core on [Nuget](https://www.nuget.org/packages/Cuemon.Core/)
* Cuemon.Data on [Nuget](https://www.nuget.org/packages/Cuemon.Data/)
* Cuemon.Data.XmlClient on [Nuget](https://www.nuget.org/packages/Cuemon.Data.XmlClient/)
* Cuemon.Integrity on [Nuget](https://www.nuget.org/packages/Cuemon.Integrity/)
* Cuemon.IO on [Nuget](https://www.nuget.org/packages/Cuemon.IO/)
* Cuemon.Net on [Nuget](https://www.nuget.org/packages/Cuemon.Net/)
* Cuemon.Net.Mail on [Nuget](https://www.nuget.org/packages/Cuemon.Net.Mail/)
* Cuemon.Reflection on [Nuget](https://www.nuget.org/packages/Cuemon.Reflection/)
* Cuemon.Runtime on [Nuget](https://www.nuget.org/packages/Cuemon.Runtime/)
* Cuemon.Runtime.Caching on [Nuget](https://www.nuget.org/packages/Cuemon.Runtime.Caching/)
* Cuemon.Security on [Nuget](https://www.nuget.org/packages/Cuemon.Security/)
* Cuemon.Serialization on [Nuget](https://www.nuget.org/packages/Cuemon.Serialization/)
* Cuemon.Serialization.Json on [Nuget](https://www.nuget.org/packages/Cuemon.Serialization.Json/)
* Cuemon.Serialization.Xml on [Nuget](https://www.nuget.org/packages/Cuemon.Serialization.Xml/)
* Cuemon.Threading on [Nuget](https://www.nuget.org/packages/Cuemon.Threading/)
* Cuemon.Web on [Nuget](https://www.nuget.org/packages/Cuemon.Web/)
* Cuemon.Xml on [Nuget](https://www.nuget.org/packages/Cuemon.Xml/)

* My profile on [LinkedIn](http://dk.linkedin.com/in/gimlichael)
* My profile on [Twitter](https://twitter.com/gimlichael)
* My profile on [StackOverflow](http://stackoverflow.com/users/175073/michael-mortensen)
* My [blog](http://www.cuemon.net/blog/)
2 changes: 1 addition & 1 deletion azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ trigger:
- README.md

variables:
- group: Integration Test
- group: BuildSecrets
- name: DOTNET_SKIP_FIRST_TIME_EXPERIENCE
value: true
- name: DOTNET_CLI_TELEMETRY_OPTOUT
Expand Down
Loading