Skip to content
This repository has been archived by the owner on Apr 6, 2020. It is now read-only.

Latest commit

 

History

History
55 lines (35 loc) · 4.36 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 4.36 KB
Raw

Contributing

Thank you for the interest in contributing to neo-sharp. To contribute, please adhere to the following guidelines:

Issue Tracking:

  • Check github for any open issues or feature requests before making a request.

  • Check the Trello Board to see the current progress of an issue or feature, and verify someone is already working on this issue before beginning work.

Testing

It's part of the goal project to reach a point where all the code running has a Unit Test that cover it. Let's face it, it's not because a project has a good test coverage mean that there is no bug. In the other end, a code without test it's a huge code-smell. When there is a change (due a bug or improvement), how do we know that everything still working as expected? Testing is important to retro-testing previous features, mean that future changes aren't breaking the current features.

The threshold to archive is around 80% test coverage and this value is not 100% because there is code that will not be testable, like: DTO objects and Third-Party calls.

How to write Unit Tests?

The methodology used for Unit Tests should be the AAA that can be found int this link (https://msdn.microsoft.com/en-us/library/hh694602.aspx).

Best Patterns and Practices to follow:

Another goal of the neo-sharp team is to grow together and help everyone become better developers than when they started working on the project. We will continue to curate a list of resources on best patterns and practices, anti-patterns, bad habits, or any other quick reads that could be beneficial to increase the quality of code contributors of the project:

General Coding Practices and Conventions:

Neo-sharp aims to adhere to Microsoft C# .NET best practices and industry standard design patterns. Please reference the following resources and familiarize yourself with recommended best practices.

  • C# Gettting Started This resource was a good crash course on some of the basics in C# if you are new to the language or if you could use a quick refresher.

  • C# Coding Conventions This is a quick resource to demonstrate code commenting, general formatting, and a quick overview.

  • .NET Framework Design Guidelines This is a comprehensive resource that enumerates everything from naming conventions, to proper exception handling, all the way to when to use certain collections and types.

  • Patterns and Anti-patterns This is a good overview of some of the more popular design patterns (and anti-patterns) with examples

Anti-patterns and bad habits

We've all done it at some point. Here you can find some links to resources on patterns and practices that could get you in trouble as a developer.

To Contribute a Pull Request:

  • Please make sure you write unit tests and those tests pass locally before issuing a pull request. Code that does not compile and pass CI testing will not be merged.

  • Open a pull request to the development branch, and reference the relevant issue(s) in Trello or Github (if relevant)

  • Ask the community for feedback and review if you are implementing a new design pattern, implementing a new module, or making any change(s) that may affect the overall architecture or design considerations of the project

  • After receiving feedback or approval, squash your commits and add a detailed commit message enumerating the features that were implemented, the bug that was addressed, or a detailed description of the changes that were implemented.

  • All commit messages must be in English