CONTRIBUTING.md

Contributing to Git Graph

• Please check the issues tab for things to work on.
• Please raise an issue to request a feature/modification or for reporting a bug, if it has not already been raised.

Tech Stack

• React.js (Create React App)

Gitpod Setup

• On clicking on the above 'Open in Gitpod' button, a Gitpod Workspace with all dependencies installed and the development server started will open up.
• Make sure to do a GitHub integration and grant permissions on the Integrations page on Gitpod if not already done.
• Make a new Git branch on Gitpod and switch to the newly created branch.
• The development server should already be started, but in case it isn't, run npm run start in the root directory of the project to start it.
  • Run npm run build to generate a production build in the build directory to test it out. Do not commit this directory.
• Make the required contribution(s) on Gitpod in the new branch.
  • Please follow the commit message format.
• To open a PR
  • Fork this repo. (Top right corner on GitHub.)
  • On Gitpod, add the forked repo as a remote.
  • Push the new branch to the forked repo.
  • Open a PR as usual from the forked repo on GitHub.

Local Setup

• Fork this repo. (Top right corner.)

• Clone the forked repo using the git clone command.

• cd into the cloned repo directory.

• Execute npm install in the root directory of the project to install all dependencies.

• Execute npm run start in the root directory of the project to start the development server.

  • Run npm run build to generate a production build in the build directory to test it out. Do not commit this directory.

• Make contribution(s).

• Write meaningful commit messages and include the number (#) of the issue being resolved (if any) at the end of the commit message.

  Example: :bug: fix: Resolve 'isCorrect' function error (#0)

  Commit message format

• Open a Pull Request (PR).

  • Learn how to open a PR.
  • Solve one issue per PR, without any extra changes.
  • Include extra changes in a separate PR.

Component Structure

objectData Structure

{
    "objects": {
        "commits": [
            {
                "hash": "<string>",
                "name": "<commit_msg>|''",
                "branchHead": "<branch_name>|''",
				"color": <boolean>
            },
            ...
        ],
        "trees": [
            {
                "hash": "<string>",
                "name": "<directory_name>|''",
				"color": <boolean>
            },
            ...
        ],
        "blobs": [
            {
                "hash": "<string>",
                "name": "<file_name>",
				"color": <boolean>
            },
            ...
        ]
    },
    "objectConnections": [
        {
            "start": "<hash|'head'>",
            "end": "<hash|formatted_file_name|''>",
			"color": <boolean>
        },
        ...
    ]
}

rawObjects Structure

{
	"objects": [
		{
			"commit": "<hash>",
            "branchHead": "<branch_name>|''",
			"commitMsg": "<commit_msg>|''",
			"parentCommit": "<hash>|''",
			"tree": "<hash>",
			"blobs": [
				{
					"type": "blob|tree",
					"name": "<file_name>|<directory_name>",
					"hash": "<string>"
				},
				...
			]
		},
		...
	],
	"recursiveTrees": {
		"<hash>": [
			{
				"type": "blob|tree",
				"name": "<file_name>|<directory_name>",
				"hash": "<string>"
			},
			...
		],
		...
	}
}

branchInfo Structure

{
    "currentBranch": {
        "name": "<branch_name>",
        "headHash": "<hash>"
    },
    "allBranches": [
        {
            "branchName": "<branch_name>",
            "branchHeadHash": "<hash>"
        },
        ...
    ]
}

Further Help

If any further help is needed, do not hesitate to contact the author (Harsh Kapadia) via Twitter @harshgkapadia, LinkedIn or e-mail ([email protected]). An issue can be raised as well.