WorkFlow for Website

[amitkaps]

Workflow

Philosophy: "Make it Work, Make it Right, Make it Fast"

• Get feature validated with comms teams e.g. Poojil & team.
• Start a feature issue and then work on the code.
• Build & add a functional working prototype to get it to WORK
• Showcase to get feedback and improvement areas from comms team
• Align with brand guidelines + get feedback from branding team e.g. Hamsa
• Refine (refactor, change, edit) the code to make it RIGHT
• Optimise to make it FAST.

Roles & Responsibilities

Development team: @schubert-da, @urmilaj, @thedivtagguy & @amitkaps

• Comms & Branding Linkage: @urmilaj, @thedivtagguy
• Pull Request Merge: @schubert-da, @thedivtagguy
• Process Improvement: @thedivtagguy, @schubert-da

Issue-Based Change

Please start by creating an Issue for the feature you are planning to work on. This allows for communication within the group - for awareness, to provide feedback, for discussion - and also helps the reviewer & you link the feature changes with the code changes. Some tips for writing a good issue to clearly and concisely communicate the problem or suggestion:

1. Give a clear & concise title: Ensure the title describes the issue in a way that is easy to understand.
2. Provide detailed description: Include a detailed explanation of the issue. Be specific and avoid assumptions & vague language. Add a checklist in the description, if there are multiple issues you want to highlight.
3. Add visuals: Especially for visual changes - annotated screenshots, sketches, or videos are very helpful in illustrating the problem.
4. Provide context: Share any additional context information about the usage or system info (e.g. OS, screen type) that would be helpful in understanding the issue.
5. Propose a solution: If you have an idea for how to address the issue, include it in the description.

Branch - Squash - Merge Workflow

We require everyone to use a Pull Request before Merging to the main branch. And also would like to have a Linear Commit History in our git repo.

We have enabled a ruleset called Linear History Pull Request to enforce that:
https://github.com/vizchitra/site/settings/rules

Branch Workflow

Once you have cloned the repo to your local drive, create a branch with the a new name. You can follow an optional naming convention for your branch: <two letter username> - <feature name> - <unique identifier> e.g. ak-typography-1

git checkout -b <branch-name>

Now go ahead and make all the code changes for the feature in that branch

Squash Workflow

Once you have finished working on the feature, please squash your commit and rebase on the current master.

Merge Workflow

Open a Pull Request (PR) for you commit. Assign at least one reviewer in the PR so that they can review and merge the request. You can and should link the PR to the feature issue you worked on. This makes it easy for the reviewer to understand the changes.