Skip to content
BranchesTags

Latest commit

History

15 Commits

Folders and files

NameName
Last commit message
Last commit date
.gitignore
.gitignore
LICENSE
LICENSE
README.md
README.md

Repository files navigation

GitFlow

This is a collection of best practices of Frannca's projects maintenance on GitHub.

Table of Contents

Motivation

There are so many great Open Source projects that is helping our company to grow that would be fair to start to share some projects as well. This year we decided to start to Open Source some of our projects on GitHub. Starting with our website and now by creating some Angular libraries. See our Projects.

First Steps

  1. Commit Message Guidelines
  2. Recommended Community Standards

Commit Message Guidelines

We use the Angular Commit Message Guidelines and to follow this guidelines, there is a great CLI wizard: Commitizen.

Commitizen installation

npm install -g commitizen

Making the repository Commitizen-friendly

commitizen init cz-conventional-changelog --save-dev --save-exact

If the project does not has the package.json file, the Commitizen CLI can not be installed. Create the file by running npm init.

For more detailed information, check the Commitizen repository.

Recommended Community Standards

The GitHub has a checklist with some important things that your project must have. It is important to follow this standards to reach out a good quality project, and to helo others to help you by submitting pull requests.

  • Description
    • Add a description for your project, it is very important because of this description the people can find your project easily.
  • README
    • The first thing that anyone sees when enters your project is the README. It is very important to create a good README. We are going to see more details in the next topics.
  • Code of conduct
    • GitHub provides two templates, but we mainly use the first one: Contributor Covenant.
  • Contributing
    • If you want to people to contribute to your project, you must have a contributing file. This file contains the guidelines to anyone that wants to report bugs and create pull request.
  • Licence
    • We always use the MIT License in all the projects on GitHub.
  • Issues or pull request templates
    • Create this files save time and creates a standard to anyone that wants to open an issue or create a pull request.

README Template

This template was inspired by many README files on Awesome README. Check the README-template and make a copy of it when starting a new project.

The main sections are:

  • Introduction
  • Table of Contents
  • Requirements
  • Installation
  • Usage
  • Configuration
  • Testing
  • Contributing
  • Copyright and license

CONTRIBUTING Template

This template was created by contributing-template. Check the CONTRIBUTING-template and make a copy of it in your project.

About

Collection of best practices used by Frannca.

frannca.com

Topics

contributingcontributing-templatefranncagitflowreadmereadme-template

Resources

Readme
MIT license
Activity
Custom properties

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - Frannca/gitflow: Collection of best practices used by Frannca. · GitHub
Skip to content
BranchesTags
Latest commit
History
15 Commits
Folders and files
NameName
Last commit message
Last commit date
.gitignore
.gitignore
LICENSE
LICENSE
README.md
README.md
Repository files navigation
GitFlow
This is a collection of best practices of Frannca's projects maintenance on
GitHub.
Table of Contents
Motivation
There are so many great Open Source projects that is helping our company to grow that would be fair to start to
share some projects as well. This year we decided to start to Open Source some of our projects on GitHub.
Starting with our website and now by creating some Angular libraries. See our
Projects.
First Steps
  1. Commit Message Guidelines
  2. Recommended Community Standards
Commit Message Guidelines
We use the Angular Commit Message Guidelines
and to follow this guidelines, there is a great CLI wizard: Commitizen.
Commitizen installation
npm install -g commitizen

Making the repository Commitizen-friendly
commitizen init cz-conventional-changelog --save-dev --save-exact

If the project does not has the package.json file, the Commitizen CLI can not be installed. Create the file by
running npm init.
For more detailed information, check the Commitizen repository.
Recommended Community Standards
The GitHub has a checklist with some important things that your project must have. It is important to follow this
standards to reach out a good quality project, and to helo others to help you by submitting pull requests.
  • Description
    • Add a description for your project, it is very important because of this description the people can find your project
easily.
  • README
    • The first thing that anyone sees when enters your project is the README. It is very important to create a good README.
We are going to see more details in the next topics.
  • Code of conduct
    • GitHub provides two templates, but we mainly use the first one: Contributor Covenant.
  • Contributing
    • If you want to people to contribute to your project, you must have a contributing file. This file contains the
guidelines to anyone that wants to report bugs and create pull request.
  • Licence
    • We always use the MIT License in all the projects on GitHub.
  • Issues or pull request templates
    • Create this files save time and creates a standard to anyone that wants to open an issue or create a pull request.
README Template
This template was inspired by many README files on Awesome README.
Check the README-template and make a copy of it when starting a new project.
The main sections are:
  • Introduction
  • Table of Contents
  • Requirements
  • Installation
  • Usage
  • Configuration
  • Testing
  • Contributing
  • Copyright and license
CONTRIBUTING Template
This template was created by contributing-template. Check the
CONTRIBUTING-template and make
a copy of it in your project.
About
Collection of best practices used by Frannca.
frannca.com
Topics
contributingcontributing-templatefranncagitflowreadmereadme-template
Resources
Readme
MIT license
Activity
Custom properties
Stars
1 star
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - Frannca/gitflow: Collection of best practices used by Frannca. · GitHub
Skip to content
BranchesTags
Latest commit
History
15 Commits
Folders and files
NameName
Last commit message
Last commit date
.gitignore
.gitignore
LICENSE
LICENSE
README.md
README.md
Repository files navigation
GitFlow
This is a collection of best practices of Frannca's projects maintenance on
GitHub.
Table of Contents
Motivation
There are so many great Open Source projects that is helping our company to grow that would be fair to start to
share some projects as well. This year we decided to start to Open Source some of our projects on GitHub.
Starting with our website and now by creating some Angular libraries. See our
Projects.
First Steps
  1. Commit Message Guidelines
  2. Recommended Community Standards
Commit Message Guidelines
We use the Angular Commit Message Guidelines
and to follow this guidelines, there is a great CLI wizard: Commitizen.
Commitizen installation
npm install -g commitizen

Making the repository Commitizen-friendly
commitizen init cz-conventional-changelog --save-dev --save-exact

If the project does not has the package.json file, the Commitizen CLI can not be installed. Create the file by
running npm init.
For more detailed information, check the Commitizen repository.
Recommended Community Standards
The GitHub has a checklist with some important things that your project must have. It is important to follow this
standards to reach out a good quality project, and to helo others to help you by submitting pull requests.
  • Description
    • Add a description for your project, it is very important because of this description the people can find your project
easily.
  • README
    • The first thing that anyone sees when enters your project is the README. It is very important to create a good README.
We are going to see more details in the next topics.
  • Code of conduct
    • GitHub provides two templates, but we mainly use the first one: Contributor Covenant.
  • Contributing
    • If you want to people to contribute to your project, you must have a contributing file. This file contains the
guidelines to anyone that wants to report bugs and create pull request.
  • Licence
    • We always use the MIT License in all the projects on GitHub.
  • Issues or pull request templates
    • Create this files save time and creates a standard to anyone that wants to open an issue or create a pull request.
README Template
This template was inspired by many README files on Awesome README.
Check the README-template and make a copy of it when starting a new project.
The main sections are:
  • Introduction
  • Table of Contents
  • Requirements
  • Installation
  • Usage
  • Configuration
  • Testing
  • Contributing
  • Copyright and license
CONTRIBUTING Template
This template was created by contributing-template. Check the
CONTRIBUTING-template and make
a copy of it in your project.
About
Collection of best practices used by Frannca.
frannca.com
Topics
contributingcontributing-templatefranncagitflowreadmereadme-template
Resources
Readme
MIT license
Activity
Custom properties
Stars
1 star
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - Frannca/gitflow: Collection of best practices used by Frannca. · GitHub
Skip to content
BranchesTags
Latest commit
History
15 Commits
Folders and files
NameName
Last commit message
Last commit date
.gitignore
.gitignore
LICENSE
LICENSE
README.md
README.md
Repository files navigation
GitFlow
This is a collection of best practices of Frannca's projects maintenance on
GitHub.
Table of Contents
Motivation
There are so many great Open Source projects that is helping our company to grow that would be fair to start to
share some projects as well. This year we decided to start to Open Source some of our projects on GitHub.
Starting with our website and now by creating some Angular libraries. See our
Projects.
First Steps
  1. Commit Message Guidelines
  2. Recommended Community Standards
Commit Message Guidelines
We use the Angular Commit Message Guidelines
and to follow this guidelines, there is a great CLI wizard: Commitizen.
Commitizen installation
npm install -g commitizen

Making the repository Commitizen-friendly
commitizen init cz-conventional-changelog --save-dev --save-exact

If the project does not has the package.json file, the Commitizen CLI can not be installed. Create the file by
running npm init.
For more detailed information, check the Commitizen repository.
Recommended Community Standards
The GitHub has a checklist with some important things that your project must have. It is important to follow this
standards to reach out a good quality project, and to helo others to help you by submitting pull requests.
  • Description
    • Add a description for your project, it is very important because of this description the people can find your project
easily.
  • README
    • The first thing that anyone sees when enters your project is the README. It is very important to create a good README.
We are going to see more details in the next topics.
  • Code of conduct
    • GitHub provides two templates, but we mainly use the first one: Contributor Covenant.
  • Contributing
    • If you want to people to contribute to your project, you must have a contributing file. This file contains the
guidelines to anyone that wants to report bugs and create pull request.
  • Licence
    • We always use the MIT License in all the projects on GitHub.
  • Issues or pull request templates
    • Create this files save time and creates a standard to anyone that wants to open an issue or create a pull request.
README Template
This template was inspired by many README files on Awesome README.
Check the README-template and make a copy of it when starting a new project.
The main sections are:
  • Introduction
  • Table of Contents
  • Requirements
  • Installation
  • Usage
  • Configuration
  • Testing
  • Contributing
  • Copyright and license
CONTRIBUTING Template
This template was created by contributing-template. Check the
CONTRIBUTING-template and make
a copy of it in your project.
About
Collection of best practices used by Frannca.
frannca.com
Topics
contributingcontributing-templatefranncagitflowreadmereadme-template
Resources
Readme
MIT license
Activity
Custom properties
Stars
1 star
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
GitHub - Frannca/gitflow: Collection of best practices used by Frannca. · GitHub
Skip to content
BranchesTags
Latest commit
History
15 Commits
Folders and files
NameName
Last commit message
Last commit date
.gitignore
.gitignore
LICENSE
LICENSE
README.md
README.md
Repository files navigation
GitFlow
This is a collection of best practices of Frannca's projects maintenance on
GitHub.
Table of Contents
Motivation
There are so many great Open Source projects that is helping our company to grow that would be fair to start to
share some projects as well. This year we decided to start to Open Source some of our projects on GitHub.
Starting with our website and now by creating some Angular libraries. See our
Projects.
First Steps
  1. Commit Message Guidelines
  2. Recommended Community Standards
Commit Message Guidelines
We use the Angular Commit Message Guidelines
and to follow this guidelines, there is a great CLI wizard: Commitizen.
Commitizen installation
npm install -g commitizen

Making the repository Commitizen-friendly
commitizen init cz-conventional-changelog --save-dev --save-exact

If the project does not has the package.json file, the Commitizen CLI can not be installed. Create the file by
running npm init.
For more detailed information, check the Commitizen repository.
Recommended Community Standards
The GitHub has a checklist with some important things that your project must have. It is important to follow this
standards to reach out a good quality project, and to helo others to help you by submitting pull requests.
  • Description
    • Add a description for your project, it is very important because of this description the people can find your project
easily.
  • README
    • The first thing that anyone sees when enters your project is the README. It is very important to create a good README.
We are going to see more details in the next topics.
  • Code of conduct
    • GitHub provides two templates, but we mainly use the first one: Contributor Covenant.
  • Contributing
    • If you want to people to contribute to your project, you must have a contributing file. This file contains the
guidelines to anyone that wants to report bugs and create pull request.
  • Licence
    • We always use the MIT License in all the projects on GitHub.
  • Issues or pull request templates
    • Create this files save time and creates a standard to anyone that wants to open an issue or create a pull request.
README Template
This template was inspired by many README files on Awesome README.
Check the README-template and make a copy of it when starting a new project.
The main sections are:
  • Introduction
  • Table of Contents
  • Requirements
  • Installation
  • Usage
  • Configuration
  • Testing
  • Contributing
  • Copyright and license
CONTRIBUTING Template
This template was created by contributing-template. Check the
CONTRIBUTING-template and make
a copy of it in your project.
About
Collection of best practices used by Frannca.
frannca.com
Topics
contributingcontributing-templatefranncagitflowreadmereadme-template
Resources
Readme
MIT license
Activity
Custom properties
Stars
1 star
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - Frannca/gitflow: Collection of best practices used by Frannca. · GitHub
Skip to content
BranchesTags
Latest commit
History
15 Commits
Folders and files
NameName
Last commit message
Last commit date
.gitignore
.gitignore
LICENSE
LICENSE
README.md
README.md
Repository files navigation
GitFlow
This is a collection of best practices of Frannca's projects maintenance on
GitHub.
Table of Contents
Motivation
There are so many great Open Source projects that is helping our company to grow that would be fair to start to
share some projects as well. This year we decided to start to Open Source some of our projects on GitHub.
Starting with our website and now by creating some Angular libraries. See our
Projects.
First Steps
  1. Commit Message Guidelines
  2. Recommended Community Standards
Commit Message Guidelines
We use the Angular Commit Message Guidelines
and to follow this guidelines, there is a great CLI wizard: Commitizen.
Commitizen installation
npm install -g commitizen

Making the repository Commitizen-friendly
commitizen init cz-conventional-changelog --save-dev --save-exact

If the project does not has the package.json file, the Commitizen CLI can not be installed. Create the file by
running npm init.
For more detailed information, check the Commitizen repository.
Recommended Community Standards
The GitHub has a checklist with some important things that your project must have. It is important to follow this
standards to reach out a good quality project, and to helo others to help you by submitting pull requests.
  • Description
    • Add a description for your project, it is very important because of this description the people can find your project
easily.
  • README
    • The first thing that anyone sees when enters your project is the README. It is very important to create a good README.
We are going to see more details in the next topics.
  • Code of conduct
    • GitHub provides two templates, but we mainly use the first one: Contributor Covenant.
  • Contributing
    • If you want to people to contribute to your project, you must have a contributing file. This file contains the
guidelines to anyone that wants to report bugs and create pull request.
  • Licence
    • We always use the MIT License in all the projects on GitHub.
  • Issues or pull request templates
    • Create this files save time and creates a standard to anyone that wants to open an issue or create a pull request.
README Template
This template was inspired by many README files on Awesome README.
Check the README-template and make a copy of it when starting a new project.
The main sections are:
  • Introduction
  • Table of Contents
  • Requirements
  • Installation
  • Usage
  • Configuration
  • Testing
  • Contributing
  • Copyright and license
CONTRIBUTING Template
This template was created by contributing-template. Check the
CONTRIBUTING-template and make
a copy of it in your project.
About
Collection of best practices used by Frannca.
frannca.com
Topics
contributingcontributing-templatefranncagitflowreadmereadme-template
Resources
Readme
MIT license
Activity
Custom properties
Stars
1 star
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
GitHub - Frannca/gitflow: Collection of best practices used by Frannca. · GitHub
Skip to content
BranchesTags
Latest commit
History
15 Commits
Folders and files
NameName
Last commit message
Last commit date
.gitignore
.gitignore
LICENSE
LICENSE
README.md
README.md
Repository files navigation
GitFlow
This is a collection of best practices of Frannca's projects maintenance on
GitHub.
Table of Contents
Motivation
There are so many great Open Source projects that is helping our company to grow that would be fair to start to
share some projects as well. This year we decided to start to Open Source some of our projects on GitHub.
Starting with our website and now by creating some Angular libraries. See our
Projects.
First Steps
  1. Commit Message Guidelines
  2. Recommended Community Standards
Commit Message Guidelines
We use the Angular Commit Message Guidelines
and to follow this guidelines, there is a great CLI wizard: Commitizen.
Commitizen installation
npm install -g commitizen

Making the repository Commitizen-friendly
commitizen init cz-conventional-changelog --save-dev --save-exact

If the project does not has the package.json file, the Commitizen CLI can not be installed. Create the file by
running npm init.
For more detailed information, check the Commitizen repository.
Recommended Community Standards
The GitHub has a checklist with some important things that your project must have. It is important to follow this
standards to reach out a good quality project, and to helo others to help you by submitting pull requests.
  • Description
    • Add a description for your project, it is very important because of this description the people can find your project
easily.
  • README
    • The first thing that anyone sees when enters your project is the README. It is very important to create a good README.
We are going to see more details in the next topics.
  • Code of conduct
    • GitHub provides two templates, but we mainly use the first one: Contributor Covenant.
  • Contributing
    • If you want to people to contribute to your project, you must have a contributing file. This file contains the
guidelines to anyone that wants to report bugs and create pull request.
  • Licence
    • We always use the MIT License in all the projects on GitHub.
  • Issues or pull request templates
    • Create this files save time and creates a standard to anyone that wants to open an issue or create a pull request.
README Template
This template was inspired by many README files on Awesome README.
Check the README-template and make a copy of it when starting a new project.
The main sections are:
  • Introduction
  • Table of Contents
  • Requirements
  • Installation
  • Usage
  • Configuration
  • Testing
  • Contributing
  • Copyright and license
CONTRIBUTING Template
This template was created by contributing-template. Check the
CONTRIBUTING-template and make
a copy of it in your project.
About
Collection of best practices used by Frannca.
frannca.com
Topics
contributingcontributing-templatefranncagitflowreadmereadme-template
Resources
Readme
MIT license
Activity
Custom properties
Stars
1 star
Watchers
1 watching
Forks
0 forks
Report repository
Releases
Packages
Contributors