https://github.com/snowballdigital/eng-practices

https://github.com/snowballdigital/eng-practices

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/snowballdigital/eng-practices
• Owner: snowballdigital
• Created: 2022-01-06T11:48:32.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-10T12:06:48.000Z (almost 3 years ago)
• Last Synced: 2023-03-02T04:11:53.868Z (almost 2 years ago)
• Size: 50.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Introduction

This the Snowball organisation's coding style guide repository for all programming launguages and frameworks used across the company.

## Motiviation

The motivation for creating this repos is to foster team collaboration and also a single source of truth to how we handle and manage code reviews as a team.

By creating this repository we also what to be able to easily onboard new colleagues as the organissation grows.

## How to contribute to this repository

- The first step to contributing would be to first clone this repo.

- Create a branch with the following convention style/explanatory-task-name e.g style/kotlin style/javascript-convention-update

- Commit your contributions to your branch. Use the imperative mood for your subject line. To read more on this please see this [article](https://cbea.ms/git-commit/) 

- If you have more than one commit, squash your commits.

- Push your branch to the remote repo.

- Create a pull request. 

- Politely ask a colleague for a review.

- The reviewer approves and merges the branch into mainline or main branch and then deletes the branch.