diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bc796ca --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +# Code Style Guide to 'RobotFire' Repo +Обращаться к [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) и к [Google C# Style Guide](https://google.github.io/styleguide/csharp-style.html) + +## Coding Rules +To ensure consistency throughout the source code, keep these rules in mind as you are working: + +* All features or bug fixes **must be tested** by one or more specs (unit-tests). +* All public API methods **must be documented**. (Details TBC). +* We follow [Google C# Style Guide](https://google.github.io/styleguide/csharp-style.html), but wrap all code at + **100 characters**. + +We have very precise rules over how our git commit messages can be formatted. This leads to **more +readable messages** that are easy to follow when looking through the **project history**. But also, +we use the git commit messages to **generate the Angular change log**. + +### Commit Message Format +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +``` +(): + + + +