Kalpesh Singh kalpeshsingh

Overview

What is your document all about?
What is the objective it achieves? Or write an object in a separate section.

Glossary

ARR? What's that? Help readers with the meaning of terms.

Assumptions

So you have made a few assumptions? List them down here.

Functions (directly in the codebase)

/**
 * @description Renders a custom heading component for font and localization usage
 * Note- The style will take precedence over any custom style props to enable control to the consumer
 *
 * @param props {object} {children, color, fontStyle, ...rest} - some more description if required
 * @returns {JSX.Element}
 * @author Name Surname <youremail@company.com>

	describe('test cases for Button component', () => {

	it('should call callback fn when onPress is fired', () => {

	/ Arrange /
	const handleClick = jest.fn()

	const { getByTestId, toJSON } = render(
	<Button onPress={handleClick}>
	<Text>Test Button</Text>

	<html>

	<head>
	<meta data-rh="true" name="twitter:label1" content="Reading time">
	<meta data-rh="true" name="twitter:data1" content="6 min read">
	</head>
	<body>
	<h1>Hello Test! 🎉 </h1>
	</body>

	/ native nodejs packages /
	const path = require("path");
	const fs = require("fs");

	/ post css import css /
	const postCssImport = require("postcss-import");

	/ extract css plugin /
	const MiniCssExtractPlugin = require("mini-css-extract-plugin");

	#!/bin/sh

	branch="$(git rev-parse --abbrev-ref HEAD)"

	# get computer name to append in Chime message
	username=$USER

	# a branch name where you want to prevent git push. In this case, it's "master"
	if [ "$branch" = "master" ]; then
	echo "You can't commit directly to '"${branch}"' branch" # webstorm or intellij will show this as popup