diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c2010c7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to this project + +Welcome, and thank you for your interest in contributing! + +The goal of this document is to provide a high-level overview of +how you can contribute and explain how we accept contribution. + +## Reporting issues + +Please use [the repository issue tracker](https://github.com/sir-csharpn/algorithm-exercises-csharp/issues) +to report any issues.. + +## Providing feedback or suggestions + +Similarly to bug reports, we accept improvement suggestions and feedback via +[the repository issue tracker](https://github.com/sir-csharpn/algorithm-exercises-csharp/issues). + +## Contributing code changes + +We are thrilled that you are interested in contributing code changes! + +You can make your own fork an next, make your increment. +You only need to meet the following requirements for new contributions: + +* Any new increment MUST have a related test +with high (or preferred full) coverage. +* Use Clean Code principles. + +Once we've confirmed that we're ready to accept your contribution, +feel free to open a pull request and link it in the issue ticket. + +I will be happy to receive new contributions! + +## Code of Conduct + +Please make sure to read and follow the [Code of Conduct](./CODE_OF_CONDUCT.md). diff --git a/README.md b/README.md index 67e5951..e457980 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![.NET CI/CD Lint](https://github.com/sir-gon/algorithm-exercises-csharp/actions/workflows/dotnet-lint.yml/badge.svg)](https://github.com/sir-gon/algorithm-exercises-csharp/actions/workflows/dotnet-lint.yml) [![Markdown Lint](https://github.com/sir-gon/algorithm-exercises-csharp/actions/workflows/markdown-lint.yml/badge.svg)](https://github.com/sir-gon/algorithm-exercises-csharp/actions/workflows/markdown-lint.yml) [![YAML lint](https://github.com/sir-gon/algorithm-exercises-csharp/actions/workflows/yamllint.yml/badge.svg)](https://github.com/sir-gon/algorithm-exercises-csharp/actions/workflows/yamllint.yml) +[![Prettier JSON lint](https://github.com/sir-gon/algorithm-exercises-csharp/actions/workflows/prettier-json.yml/badge.svg)](https://github.com/sir-gon/algorithm-exercises-csharp/actions/workflows/prettier-json.yml) ![GitHub](https://img.shields.io/github/license/sir-gon/algorithm-exercises-csharp) ![GitHub language count](https://img.shields.io/github/languages/count/sir-gon/algorithm-exercises-csharp) @@ -17,6 +18,8 @@ [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=sir-gon_algorithm-exercises-csharp&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=sir-gon_algorithm-exercises-csharp) [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=sir-gon_algorithm-exercises-csharp&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=sir-gon_algorithm-exercises-csharp) +[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9287/badge)](https://www.bestpractices.dev/projects/9287) + ## TL;DR Algorithms Exercises solved in [C# / .NET](https://dotnet.microsoft.com/languages/csharp),