README.md

Ubiety.StyleCop

StyleCop rules and settings for shared projects

Branch	Appveyor
Master
Develop

Installing / Getting started

Ubiety StyleCop is available from NuGet

dotnet package install Ubiety.StyleCop

You can also use your favorite NuGet client.

Developing

Here's a brief intro about what a developer must do in order to start developing the project further:

git clone https://github.com/ubiety/Ubiety.StyleCop.git
cd Ubiety.StyleCop
dotnet restore

Clone the repository and then restore the development requirements. You can use any editor, Rider, VS Code or VS 2017. The library supports all .NET Core platforms.

Building

Building is simple

./build.ps1

Deploying / Publishing

git pull
versionize
dotnet pack
dotnet nuget push
git push

Contributing

When you publish something open source, one of the greatest motivations is that anyone can just jump in and start contributing to your project.

These paragraphs are meant to welcome those kind souls to feel that they are needed. You should state something like:

"If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome."

If there's anything else the developer needs to know (e.g. the code style guide), you should link it here. If there's a lot of things to take into consideration, it is common to separate this section to its own file called CONTRIBUTING.md (or similar). If so, you should say that it exists here.

Links

• Project homepage: https://stylecop.ubiety.ca
• Repository: https://github.com/ubiety/Ubiety.StyleCop/
• Issue tracker: https://github.com/ubiety/Ubiety.StyleCop/issues
  • In case of sensitive bugs like security vulnerabilities, please contact the Tidelift security contact directly instead of using issue tracker. We value your effort to improve the security and privacy of this project!
• Related projects:
  • Ubiety VersionIt: https://github.com/ubiety/Ubiety.VersionIt/
  • Ubiety Toolset: https://github.com/ubiety/Ubiety.Toolset/
  • Ubiety Xmpp: https://github.com/ubiety/Ubiety.Xmpp.Core/
  • Ubiety Dns: https://github.com/ubiety/Ubiety.Dns.Core/
  • Ubiety Stringprep: https://github.com/ubiety/Ubiety.Stringprep.Core/
  • Ubiety SCRAM: https://github.com/ubiety/Ubiety.Scram.Core/

Sponsors

Gold Sponsors

Silver Sponsors

Bronze Sponsors

Licensing

The code in this project is licensed under the Apache License version 2.