Jiho Choi JihoChoi

Commit Message Guidelines

In the last few years, the number of programmers concerned about writing structured commit messages have dramatically grown. As exposed by Tim Pope in article readable commit messages are easy to follow when looking through the project history. Moreover the AngularJS contributing guides introduced conventions that can be used by automation tools to automatically generate useful documentation, or by developers during debugging process.

This document borrows some concepts, conventions and even text mainly from these two sources, extending them in order to provide a sensible guideline for writing commit messages.

Goals
Proposal
- Commit Message Format

Allowed ``

Markdown License badges

Collection of License badges for your Project's README file.
This list includes the most common open source and open data licenses.
Easily copy and paste the code under the badges into your Markdown files.

Notes

The badges do not fully replace the license informations for your projects, they are only emblems for the README, that the user can see the License at first glance.

Translations: (No guarantee that the translations are up-to-date)

🇫🇷 Cette liste en français

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

This gist lets you keep IPython notebooks in git repositories. It tells git to ignore prompt numbers and program outputs when checking that a file has changed.

To use the script, follow the instructions given in the script's docstring.

For further details, read this blogpost.

The procedure outlined here is inspired by this answer on Stack Overflow.

Directory structure for JavaScript/Node Projects

While the following structure is not an absolute requirement or enforced by the tools, it is a recommendation based on what the JavaScript and in particular Node community at large have been following by convention.

Beyond a suggested structure, no tooling recommendations, or sub-module structure is outlined here.

Directories

lib/ is intended for code that can run as-is
src/ is intended for code that needs to be manipulated before it can be used

Commit Message Conventions

These rules are adopted from the AngularJS commit conventions.

Goals
Generating CHANGELOG.md
- Recognizing unimportant commits
- Provide more information when browsing the history
Format of the commit message
Subject line

	1. Go to Sublime Text to: Tools -> Build System -> New Build System
	and put the next lines:

	{
	"cmd": ["python3", "-i", "-u", "$file"],
	"file_regex": "^[ ]File \"(...?)\", line ([0-9]*)",
	"selector": "source.python"
	}

	Then save it with a meaningful name like: python3.sublime-build

	from igraph import *
	import numpy as np

	# Create the graph
	vertices = [i for i in range(7)]
	edges = [(0,2),(0,1),(0,3),(1,0),(1,2),(1,3),(2,0),(2,1),(2,3),(3,0),(3,1),(3,2),(2,4),(4,5),(4,6),(5,4),(5,6),(6,4),(6,5)]

	g = Graph(vertex_attrs={"label":vertices}, edges=edges, directed=True)

	visual_style = {}

	import sys
	import numpy as np
	import networkx as nx
	import matplotlib.pyplot as plt

	def plot(data,filename,degreetype):
	""" Plot Distribution """
	plt.plot(range(len(data)),data,'bo')
	plt.yscale('log')
	plt.xscale('log')