Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/intellitect/codingguidelines

A repository to contain IntelliTect's tools for coding conventions
https://github.com/intellitect/codingguidelines

intellitect

Last synced: 1 day ago
JSON representation

A repository to contain IntelliTect's tools for coding conventions

Host: GitHub
URL: https://github.com/intellitect/codingguidelines
Owner: IntelliTect
License: mit
Created: 2019-06-26T18:36:30.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-11-04T16:23:16.000Z (3 days ago)
Last Synced: 2024-11-04T17:27:58.731Z (3 days ago)
Topics: intellitect
Language: C#
Homepage: https://intellitect.github.io/CodingGuidelines/
Size: 940 KB
Stars: 11
Watchers: 2
Forks: 17
Open Issues: 54
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: docs/security/index.md

Awesome Lists containing this project

README

        [![NuGet Status](http://img.shields.io/nuget/v/IntelliTect.Analyzers.svg?style=flat&color=blue&label=IntelliTect.Analyzers)](https://www.nuget.org/packages/IntelliTect.Analyzers/)

[![CodingGuidelines Build](https://github.com/IntelliTect/CodingGuidelines/actions/workflows/dotnetBuild.yml/badge.svg)](https://github.com/IntelliTect/CodingGuidelines/actions/workflows/dotnetBuild.yml)

[Coding Snippets Repository](https://github.com/IntelliTect/IntelliTect.Snippets)

[Coding Snippets Extension](https://marketplace.visualstudio.com/items?itemName=IntelliTect.intellitectsnippets)

# Coding Guidelines / Design Guidelines

A repository to contain IntelliTect's tools for coding conventions. [https://intellitect.github.io/CodingGuidelines/](https://intellitect.github.io/CodingGuidelines/)

## Guidelines Site Maintenance

 There are two github actions that are used to update the CodingGuidelinesSite. One action ( *Update csharp Markdown* ) will run automatically when the XML file in the master branch is updated via a commit. The CodingGuidelines github page will then reflect the changes. After reviewing the "dev" site, there is another action ( *Update Docs Folder on CodingGuidelinesSite* ) that will move the new markdown file to production site [CodingGuidelinesSite]( https://intellitect.github.io/CodingGuidelinesSite/). 

There is also another action to manually run a xml to md conversion on any branch. There is a retired tool that was used to extract guidelines from the manuscript word documents to an XML file here: [Manuscript Guidelines Extractor](https://github.com/EssentialCSharp/EssentialCSharp.Utilities.GuidelinesExtractor)