DEV Community: Pratik Ambani

Git Strategy for Sanity

Pratik Ambani — Tue, 31 Jul 2018 08:07:36 +0000

"Ah!! Plenty of articles here on the git, I don't want another one." - My first reaction when I reviewed this before publishing. 😜

Well, we as a team follow a predefined set of rules before committing codebase in git. I'm sharing the same over here as I find them very promising in order to maintain git sanity.

Your code is formatted. (let me know in comments if you are also suffering from this phobia 😧 ).
Don't you dare committing an erroneous code. 😈👿
Don't forget to update your README.md regularly with required updates on each commit. You may wish to have a look at this article.
Commit Message must start with Jira ticket number(i.e. XYZ-1234).
The second word of commit message must be either of (added, removed, changed, refactored, corrected).
Nobody commits on master and feature/parent branch.

Extensions and Utilities:

I would strongly suggest you to configure,

Configure GitHub with Jenkins, which would help you trigger automated Jenkins builds upon committing to GitHub
Configure GitHub with Sonar Qube, which would trigger Code Review upon pushing any code in GitHub
GitHub with Jira, which would help you check progress(commit logs) on Jira

Rules while creating new Repository:

This will be default structure for any new repository to be created in Production.

Master will contain only README.md
Release will be passed via feature/parent branch only.
feature/develop and feature/fixes will be merged into feature/parent only when the code is reviewed
All new branches will be extension of develop branch only
Need new Repo?: Create as much as you want, but keep em private only.
Default collaboration: only to required people

As usual, suggestions are always welcomed. Happy Coding and may the code bless you. 😇

A meaningful README.md

Pratik Ambani — Mon, 02 Jul 2018 04:43:16 +0000

After working for more than 5 years in the field of Development I started realizing the importance of Documentation, and hence I thought to write on documenting README.md file.

Here are some of the patterns I personally follow and made it a mandate to my team after creating a new repository or before committing codebase in existing repository, have a look at my README.md and markdown all informative notes.

Project title

These services are part of Blah Blah Blah Project.

Screens

Just to let you guys know, you can also add gifs in your (readme.md)markdown file.

Before you commit

Before committing code please ensure,

README.md is updated
A successful build and jar is deployed on nexus
All newly implemented APIs are documented
All newly added properties are documented in additional-spring-configuration-metadata.json

Libraries used

Spring Boot 1.5.1.RELEASE
Custom: Exceptions, File IO, Rest Authentication
Spring Boot Test
JSON Library(javax.json)
Swagger API
Hibernate Validation API (org.hibernate)
Random Numbers and String Generators(smt-random-strings and smt-random-numbers)

Features

These services can perform,

Employee CRUD operations.

Installing

A step by step series of examples that tell you how to get a development env running

Deployment

Add additional notes about how to deploy this on a live system

JIRA References

Add all JIRA Tickets with Hyperlinks

Versions

1.0-SNAPSHOT: Contains Add, View, Update, and Delete Employees

Developers

Pratik Ambani(Pratik.ambani@companydomain.com)

License

A short snippet describing the license (MIT, Apache etc)

As usual, suggestions are always welcomed. Happy Coding and may the code bless you. 😇

TIP: Keep your README.md updated if you believe in KARMA. 😉

Explain OAuth like I'm Five

Pratik Ambani — Thu, 07 Jun 2018 11:51:12 +0000

Explain idempotency (in REST) like I'm Five

Pratik Ambani — Thu, 07 Dec 2017 01:21:09 +0000

Explain Cross Site Scripting(XSS) attacks like I'm Five

Pratik Ambani — Fri, 20 Oct 2017 03:19:07 +0000

Explain HTTP Verbs like I'm Five

Pratik Ambani — Sat, 14 Oct 2017 16:18:51 +0000