Skip to content

Instantly share code, notes, and snippets.

@Scipion
Scipion / README.md
Created February 9, 2024 16:36 — forked from jakebrinkmann/README.md
GitHub special files and paths, such as README, LICENSE, CONTRIBUTING, CODE_OF_CONDUCT

Common special files found in the root directory of a repository

Description for and list of popular special files like README/CHANGELOG/LICENSE and others.

README-like

ReadMe README.md README

The ReadMe is usually the first document people will see of your project. Depending on your project it should give a short introduction and usage/build examples. It should only contain the information you expect users to read. It is usually possible to link to other documentation files using the markdown syntax which gets rendered as html by popular repository hosting platforms.

@Scipion
Scipion / semantic-commit-messages.md
Created February 3, 2023 09:11 — forked from joshbuchea/semantic-commit-messages.md
Semantic Commit Messages

Semantic Commit Messages

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional

Example

/* MutationObserver*/
function observe(selector){
var targetNodes = document.querySelectorAll(selector);
// Options for the observer (which mutations to observe)
var config = { attributes: true, childList: true, subtree: true };
// Callback function to execute when mutations are observed
var callback = function(mutationsList) {
for(var mutation of mutationsList) {