Git Product home page Git Product logo

andculturecode.csharp.core's Introduction

AndcultureCode

All Contributors

We are the engineering team at andculture focused on developing technology solutions. Come build with us.

While we use a wide array of technologies at andculture, we tend to build primarily in .NET Core C# and React TypeScript. The goal of this repository is to document our engineering team best practices around specific technologies as well as the department at large.

andCulture Logo

How to contribute

While we do a lot of work for private organizations, we strive to collaborate with the community as much as possible. We have a variety of repositories broken out by language and purpose.

Please browse our github respositories using the following naming convention as a guide.

AndcultureCode.{LanguageName}.{PackageName}.{ChildPackageName}
// ex. AndcultureCode.CSharp.Extensions

AndcultureCode.{LanguageName}.{PopularPackageName}
// ex. AndcultureCode.CSharp.FactoryGirl

Once you find a repository of interest, please give our contributions guide a read.

Contributors โœจ

Thanks goes to these wonderful people (emoji key):


Kevin Busch

๐Ÿ‘€ ๐Ÿ“–

Jim Stevenson

๐Ÿ‘€ ๐Ÿ“–

Mike Koser

๐Ÿ‘€

Winton DeShong

๐Ÿšง ๐Ÿ‘€ ๐Ÿ“–

Dylan Justice

๐Ÿ‘€ ๐Ÿ“–

Brandon Scott

๐Ÿšง ๐Ÿ‘€ ๐Ÿ“–

Michael Tyson

๐Ÿ‘€ ๐Ÿ“–

Stefanie Leitch

๐Ÿ‘€ ๐Ÿ“–

Joshua Peters

๐Ÿ‘€ ๐Ÿ“–

Joshua Hughes

๐Ÿ’ป

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

andculturecode.csharp.core's People

Contributors

allcontributors[bot] avatar andculture avatar brandongregoryscott avatar craigbanach avatar dependabot[bot] avatar dylanjustice avatar dzoccarato avatar hey-mikey avatar kashifsoofi avatar rolfers avatar stefanie899 avatar wintondeshong avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

andculturecode.csharp.core's Issues

'HasErrorsFor' IResultExtension

Similar to the IResultMatcherExtensions method ShouldHaveErrorsFor in our testing package, it would be nice to have an extension method that checks for a specific error key on an IResult, so that controller returns (or any sort of method returns) can be separated out depending on a specific key. Example use case:

var createResult = Create(dto.SectionId.Value);
if (createResult.HasErrorsFor(ERROR_REFERENCE_EXISTS))
{
    return BadRequest<UserReferenceDto>(createResult.Errors, _logger);
}

if (createResult.HasErrors)
{
    return InternalError<UserReferenceDto>(createResult.Errors, _logger);
}

Code coverage isn't being generated - bump coverlet to 2.9.0

The version of coverlet we're on doesn't support .NET Core 3.1. We should bump the version to 2.9.0 to allow coverage reports to be generated with 3.1.

Documentation in the README.md file also needs to be updated to mention the correct command for generating test coverage and-cli dotnet-test --coverage as well as the file that's generated: coverage.opencover.xml

Add an overload for `IRepositoryReadConductor#FindById` which accepts additional filters

@ralphjmcintyre and I recently ran into a situation in a client project where, based on a user's role in the system, we either want to include or exclude "unpublished" records. It would be useful, and also potentially more efficient, if we were able to do basically "find by ID, if it also matches this filter".

Could be something like:

_readConductor.FindById(id: id, filter: e => e.PublishedOn.HasValue)

Fix regression of AWS EB environment variable handling

We have determined that there has been a regression in how the Amazon Beanstalk extensions and related classes that manage environment variables. There must have been a fix made and published that was not actually committed/pushed between v0.2.1 and v0.3.0.

I have decompiled the assemblies between those versions and identified some key differences in the internal caching of the loaded configurations. Work completed thus far is here https://github.com/wintondeshong/AndcultureCode.CSharp.Core/tree/bugfix/add-missing-code-from-aws-eb-related-code

Rename default branch from "master" to "main".

Feature request

What is the expected behavior?
To have the default branch named main instead of master

What is motivation or use case for adding/changing the behavior?
Removing terminology in technology evocative of racial inequality.

How should this be implemented in your opinion?
Following Scott Hanselman's advice

  1. Move master to main (maintains branch history)
git branch -m master main
git push -u origin main
  1. Update the default branch in repo settings from master to main.
  2. Repoint HEAD, and delete master branch.
git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/main
git push origin --delete master

Are you willing to work on this yourself?
no

Namespaces for Models are incorrect

For a couple of models, the namespaces are incorrect and do not reflect the folder structure.

Here is the list ( - - :

  • Acl - AndcultureCode.CSharp.Core.Models.Entities - AndcultureCode.CSharp.Core.Models.Entities.Acls
  • Error - AndcultureCode.CSharp.Core.Models - AndcultureCode.CSharp.Core.Models.Errors
  • Result<T> - AndcultureCode.CSharp.Core.Models - AndcultureCode.CSharp.Core.Models.Errors

This is likely a breaking change, so we might need to think through how to best handle this.

Add ERROR_RESOURCE_NOT_FOUND translation to cultures file

Something small missed with a recent change (by me ๐Ÿ˜›)

In order to share this error key across projects, and to prevent consumers from having to add the key/message translation manually, we'll want to add this error key to the cultures file.

Batch Delete overload for IRepositoryDeleteConductor

In some recent debugging, we noticed there is currently no batch delete overload available in the IRepositoryDeleteConductor interface. A batch delete would be nice for scenarios where a bulk delete (which locks the table) is overkill, or even just smaller sets of data.

IRepositoryCreateConductor has a Create signature like this:

IResult<List<T>> Create(IEnumerable<T> items, long? createdById = null);

and IRepositoryUpdateConductor has an Update signature like this:

IResult<bool> Update(IEnumerable<T> items, long? updatedBy = default(long?));

I am proposing a Delete signature like so:

IResult<bool> Delete(IEnumerable<T> items, long? deletedById = null);

An XML doc comment above this signature and the BulkDelete would be beneficial for a consumer. Most notably, the BulkDelete leverages an EF Core bulk operation package and involves locking the table to complete the operation, whereas the batch delete function simply marks the changes for each entity & saves the context at the end.

After this signature is added, we will want to implement the method in https://github.com/AndcultureCode/AndcultureCode.CSharp.Conductors

Add/fix XML doc comments for Cultures

See warning list from a recent build:

Cultures\EnglishUnitedStates.cs(6,18): warning CS1591: Missing XML comment for publicly visible type or member 'EnglishUnitedStates' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Cultures\EnglishUnitedStates.cs(8,32): warning CS1591: Missing XML comment for publicly visible type or member 'EnglishUnitedStates.Code' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Cultures\EnglishUnitedStates.cs(9,30): warning CS1591: Missing XML comment for publicly visible type or member 'EnglishUnitedStates.IsDefault' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Cultures\SpanishSpain.cs(6,18): warning CS1591: Missing XML comment for publicly visible type or member 'SpanishSpain' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Cultures\SpanishSpain.cs(8,32): warning CS1591: Missing XML comment for publicly visible type or member 'SpanishSpain.Code' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]

Add or fix comments as needed to reduce the number of warnings.

If you're not sure what a function/field does and you're an andculture employee, feel free to ask to pair with another engineer or in Slack to figure out how to best document the actor, or move on to another area.

If you're not an andculture employee, try to add something to the best of your ability - otherwise, feel free to add in a TODO comment with a link to this issue so another engineer can search for those in the code base and fill them in with an actual description. For example:

/// <summary>
/// TODO https://github.com/AndcultureCode/AndcultureCode.CSharp.Core/issues/38
/// </summary>
/// <param name="key"></param>
/// <param name="value"></param>
public void Add(TKey key, TValue value)
...

Port IncludeExtensions

NOTE: Must be an andculture employee to work on this issue due to requiring access to private resources.

From the LMS project, port over the IncludeExtensions static class used for building out include property strings. While it has unit tests, please review during the port and see if it requires more.

Once done, we will want to refactor this and other projects to leverage the new extension method approach.

Change PackIconUrl to PackageIcon in csproj file

There is a warning regarding the nuget packing information when running the dotnet build:

"The 'PackageIconUrl'/'iconUrl' element is deprecated. Consider using the 'PackageIcon'/'icon' element instead. Learn more at https://aka.ms/deprecateIconUrl"

Nuget nows wants icons to be embedded in the pack file (See issue: 352)

Should be changed to:

<PropertyGroup>
    ...
    <PackageIconUrl>https://github.com/AndcultureCode/AndcultureCode/blob/main/assets/andculture-glyph%402x.png</PackageIconUrl>
    <PackageIcon>[email protected]</PackageIcon>
    ...
</PropertyGroup>

<ItemGroup>
    <None Include="Images\[email protected]" Pack="true" PackagePath=""/>
</ItemGroup>

A high resolution glyph can be found in our home repo here and should be copied to an Images folder: https://github.com/AndcultureCode/AndcultureCode/blob/main/assets/andculture-glyph%402x.png

Backfill Tests for IResultExtensions

Coverage report

// IResultExtensions

public static List<IError> AddErrors<T, TSource>(this IResult<T> destination, IResult<TSource> source)

public static void AddErrorAndLog<T>(this IResult<T> result, ILogger logger, string errorKey, string errorMessage, long? resourceIdentifier = null)

public static void AddErrorsAndLog<T>(this IResult<T> result, ILogger logger, string errorKey, string errorMessage, long resourceIdentifier, IEnumerable<IError> errors = null)

public static void AddErrorsAndLog<T>(this IResult<T> result, ILogger logger, string errorKey, string errorMessage, long? resourceIdentifier, IEnumerable<IError> errors = null)

public static void AddErrorsAndLog<T>(this IResult<T> result, ILogger logger, string errorKey, string errorMessage, string logMessage, string resourceIdentifier, IEnumerable<IError> errors = null, string methodName = null)

public static void AddErrorAndLog<T>(this IResult<T> result, ILogger logger, IStringLocalizer localizer, string errorKey, params object[] arguments)

public static void AddErrorAndLog<T>(this IResult<T> result, ILogger logger, IStringLocalizer localizer, string errorKey, long? resourceIdentifier, params object[] arguments)

public static void AddErrorAndLog<T>(this IResult<T> result, ILogger logger, IStringLocalizer localizer, string errorKey, long resourceIdentifier, params object[] arguments)

public static void AddErrorsAndLog<T>(this IResult<T> result, ILogger logger, IStringLocalizer localizer, string errorKey, long resourceIdentifier, IEnumerable<IError> errors = null, params object[] arguments)

public static bool DoesNotHaveErrors<T>(this IResult<T> result, ErrorType errorType) => !result.HasErrors(errorType);

public static bool DoesNotHaveErrors<T>(this IResult<T> result, string key) => !result.HasErrors(key);

public static List<IError> GetErrors<T>(this IResult<T> result, ErrorType errorType)

public static List<IError> GetErrors<T>(this IResult<T> result, string key)

public static List<IError> GetValidationErrors<T>(this IResult<T> result) => result.GetErrors(ErrorType.ValidationError);

public static bool HasErrorsOrResultIsFalse(this IResult<bool> result)

public static bool HasErrorsOrResultIsNull<T>(this IResult<T> result)

public static bool HasValidationErrors<T>(this IResult<T> result)

public static IResult<T> ThrowIfAnyErrors<T>(this IResult<T> result, Exception customException = null)

public static IResult<bool> ThrowIfAnyErrorsOrResultIsFalse()

// Result<T>

public Result(T resultObject)

Add/fix XML doc comments for Providers

See warning list from a recent build:

Providers\WorkerProvider.cs(14,30): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.Delete(string)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(15,30): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.DeletedCount()' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(17,32): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.Enqueue(Expression<Action>)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(18,32): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.Enqueue<T>(Expression<Action<T>>)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(19,30): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.EnqueuedCount(string)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(27,30): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.Recur(string, Expression<Action>, RecurringOption)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(28,30): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.Recur<T>(string, Expression<Action<T>>, string)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(29,30): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.Recur<T>(string, Expression<Action<T>>, RecurringOption)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(30,30): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.RecurringCount()' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(31,30): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.RemoveRecurrence(string)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(33,32): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.Schedule(Expression<Action>, DateTimeOffset)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(34,32): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.Schedule<T>(Expression<Action<T>>, DateTimeOffset)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(35,32): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.Schedule(Expression<Action>, TimeSpan)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Providers\WorkerProvider.cs(36,32): warning CS1591: Missing XML comment for publicly visible type or member 'WorkerProvider.Schedule<T>(Expression<Action<T>>, TimeSpan)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]

Add or fix comments as needed to reduce the number of warnings.

If you're not sure what a function/field does and you're an andculture employee, feel free to ask to pair with another engineer or in Slack to figure out how to best document the actor, or move on to another area.

If you're not an andculture employee, try to add something to the best of your ability - otherwise, feel free to add in a TODO comment with a link to this issue so another engineer can search for those in the code base and fill them in with an actual description. For example:

/// <summary>
/// TODO https://github.com/AndcultureCode/AndcultureCode.CSharp.Core/issues/38
/// </summary>
/// <param name="key"></param>
/// <param name="value"></param>
public void Add(TKey key, TValue value)
...

Add/fix XML doc comments for 'Do' and 'Try'

See warning list from a recent build:

Do.cs(18,26): warning CS1591: Missing XML comment for publicly visible type or member 'Do<T>.Exception' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Do.cs(19,27): warning CS1591: Missing XML comment for publicly visible type or member 'Do<T>.Result' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Do.cs(20,36): warning CS1591: Missing XML comment for publicly visible type or member 'Do<T>.Workload' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Do.cs(27,16): warning CS1591: Missing XML comment for publicly visible type or member 'Do<T>.Do(Func<IResult<T>, T>)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Do.cs(38,22): warning CS1591: Missing XML comment for publicly visible type or member 'Do<T>.Catch<TException>(Action<TException, IResult<T>>)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Do.cs(78,22): warning CS1591: Missing XML comment for publicly visible type or member 'Do<T>.Finally(Action<IResult<T>>)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Do.cs(106,29): warning CS1591: Missing XML comment for publicly visible type or member 'Do<T>.Try(Func<IResult<T>, T>)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Try.cs(5,25): warning CS1591: Missing XML comment for publicly visible type or member 'Try' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Try.cs(7,28): warning CS1591: Missing XML comment for publicly visible type or member 'Try.Catch(Action)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]

Add or fix comments as needed to reduce the number of warnings.

If you're not sure what a function/field does and you're an andculture employee, feel free to ask to pair with another engineer or in Slack to figure out how to best document the actor, or move on to another area.

If you're not an andculture employee, try to add something to the best of your ability - otherwise, feel free to add in a TODO comment with a link to this issue so another engineer can search for those in the code base and fill them in with an actual description. For example:

/// <summary>
/// TODO https://github.com/AndcultureCode/AndcultureCode.CSharp.Core/issues/38
/// </summary>
/// <param name="key"></param>
/// <param name="value"></param>
public void Add(TKey key, TValue value)
...

Add/fix XML doc comments for Utilities

See warning list from a recent build:

Utilities\Configuration\AmazonEBConfigurationProvider.cs(30,23): warning CS1591: Missing XML comment for publicly visible type or member 'AmazonEBConfigurationProvider.ConfigurationFilePath' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Configuration\AmazonEBConfigurationProvider.cs(31,21): warning CS1591: Missing XML comment for publicly visible type or member 'AmazonEBConfigurationProvider.StdoutEnabled' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Configuration\AmazonEBConfigurationProvider.cs(38,16): warning CS1591: Missing XML comment for publicly visible type or member 'AmazonEBConfigurationProvider.AmazonEBConfigurationProvider()' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Configuration\AmazonEBConfigurationProvider.cs(39,16): warning CS1591: Missing XML comment for publicly visible type or member 'AmazonEBConfigurationProvider.AmazonEBConfigurationProvider(bool, string)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Configuration\AmazonEBConfigurationProvider.cs(60,31): warning CS1591: Missing XML comment for publicly visible type or member 'AmazonEBConfigurationProvider.Get(string)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Configuration\AmazonEBConfigurationProvider.cs(62,29): warning CS1591: Missing XML comment for publicly visible type or member 'AmazonEBConfigurationProvider.Has(string)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Configuration\AmazonEBConfigurationProvider.cs(64,52): warning CS1591: Missing XML comment for publicly visible type or member 'AmazonEBConfigurationProvider.Read()' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Configuration\AmazonEBConfigurationSource.cs(5,18): warning CS1591: Missing XML comment for publicly visible type or member 'AmazonEBConfigurationSource' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Configuration\AmazonEBConfigurationSource.cs(7,39): warning CS1591: Missing XML comment for publicly visible type or member 'AmazonEBConfigurationSource.Build(IConfigurationBuilder)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Hosting\AndcultureCodeWebHost.cs(6,25): warning CS1591: Missing XML comment for publicly visible type or member 'AndcultureCodeWebHost' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Localization\LocalizationUtils.cs(10,25): warning CS1591: Missing XML comment for publicly visible type or member 'LocalizationUtils' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Localization\LocalizationUtils.cs(47,41): warning CS1591: Missing XML comment for publicly visible type or member 'LocalizationUtils.CultureInfos' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Localization\LocalizationUtils.cs(49,32): warning CS1591: Missing XML comment for publicly visible type or member 'LocalizationUtils.DefaultCulture' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Localization\LocalizationUtils.cs(51,30): warning CS1591: Missing XML comment for publicly visible type or member 'LocalizationUtils.DefaultCultureCode' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Localization\LocalizationUtils.cs(53,35): warning CS1591: Missing XML comment for publicly visible type or member 'LocalizationUtils.DefaultCultureInfo' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Localization\LocalizationUtils.cs(60,32): warning CS1591: Missing XML comment for publicly visible type or member 'LocalizationUtils.CultureByCode(string)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Localization\LocalizationUtils.cs(63,30): warning CS1591: Missing XML comment for publicly visible type or member 'LocalizationUtils.CultureCodes(string)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]
Utilities\Localization\LocalizationUtils.cs(66,28): warning CS1591: Missing XML comment for publicly visible type or member 'LocalizationUtils.CultureExists(string)' [C:\Users\bscot\acc\origin\AndcultureCode.CSharp.Core\src\AndcultureCode.CSharp.Core\AndcultureCode.CSharp.Core.csproj]

Add or fix comments as needed to reduce the number of warnings.

If you're not sure what a function/field does and you're an andculture employee, feel free to ask to pair with another engineer or in Slack to figure out how to best document the actor, or move on to another area.

If you're not an andculture employee, try to add something to the best of your ability - otherwise, feel free to add in a TODO comment with a link to this issue so another engineer can search for those in the code base and fill them in with an actual description. For example:

/// <summary>
/// TODO https://github.com/AndcultureCode/AndcultureCode.CSharp.Core/issues/38
/// </summary>
/// <param name="key"></param>
/// <param name="value"></param>
public void Add(TKey key, TValue value)
...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.