2020-04-06 12:17:40 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
2021-07-06 14:30:09 +00:00
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8" />
|
|
|
|
|
<title>Contribution Guidelines | freeCodeCamp.org</title>
|
|
|
|
|
<link rel="icon" href="images/branding/favicon.ico" />
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
|
|
|
|
<meta name="description" content="Description" />
|
|
|
|
|
<meta
|
|
|
|
|
name="viewport"
|
|
|
|
|
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
|
|
|
|
|
/>
|
|
|
|
|
<!--social-->
|
|
|
|
|
<meta content="freeCodeCamp.org" name="og:title" />
|
|
|
|
|
<meta
|
2022-05-28 05:13:20 +00:00
|
|
|
content="Contributing documentation for working on freeCodeCamp's open source codebase."
|
|
|
|
|
name="og:description"
|
|
|
|
|
/>
|
|
|
|
|
<meta
|
|
|
|
|
content="https://cdn.freecodecamp.org/platform/universal/fcc_meta_1920X1080-indigo.png"
|
2021-07-06 14:30:09 +00:00
|
|
|
property="og:image"
|
|
|
|
|
/>
|
|
|
|
|
|
|
|
|
|
<meta
|
|
|
|
|
content="summary_large_image"
|
|
|
|
|
key="twitter:card"
|
|
|
|
|
name="twitter:card"
|
|
|
|
|
/>
|
|
|
|
|
<meta
|
2022-05-28 05:13:20 +00:00
|
|
|
content="https://cdn.freecodecamp.org/platform/universal/fcc_meta_1920X1080-indigo.png"
|
|
|
|
|
name="twitter:image"
|
2021-07-06 14:30:09 +00:00
|
|
|
/>
|
|
|
|
|
<meta content="freeCodeCamp.org" name="twitter:title" />
|
2022-05-28 05:13:20 +00:00
|
|
|
<meta
|
|
|
|
|
content="Contributing documentation for working on freeCodeCamp's open source codebase."
|
|
|
|
|
name="twitter:description"
|
|
|
|
|
/>
|
2021-07-06 14:30:09 +00:00
|
|
|
|
|
|
|
|
<link
|
|
|
|
|
rel="stylesheet"
|
2021-08-09 10:50:16 +00:00
|
|
|
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css"
|
|
|
|
|
integrity="sha512-1ycn6IcaQQ40/MKBW2W4Rhis/DbILU74C1vSrLJxCq57o941Ym01SwNsOMqvEBFlcgUa6xLiPY/NS5R+E6ztJQ=="
|
2021-07-06 14:30:09 +00:00
|
|
|
crossorigin="anonymous"
|
|
|
|
|
/>
|
|
|
|
|
|
|
|
|
|
<!-- Theme -->
|
|
|
|
|
<!-- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css"> -->
|
|
|
|
|
<link
|
|
|
|
|
rel="stylesheet"
|
|
|
|
|
href="https://cdn.jsdelivr.net/npm/docsify/themes/vue.css"
|
|
|
|
|
/>
|
|
|
|
|
<!-- Custom theme stylesheet -->
|
|
|
|
|
<link rel="stylesheet" href="_theme.css" />
|
|
|
|
|
</head>
|
|
|
|
|
|
2022-10-05 14:08:50 +00:00
|
|
|
<body>
|
2021-07-06 14:30:09 +00:00
|
|
|
<!-- Navigation (we are using a div, instead of nav to avoid conflict with docsify's nav) -->
|
|
|
|
|
<div class="universal-nav">
|
|
|
|
|
<a class="app-name-link" data-nosearch="" href="/">
|
|
|
|
|
<img alt="freeCodeCamp.org" src="images/branding/primary_logo.svg" />
|
|
|
|
|
</a>
|
|
|
|
|
<a class="translations-link" data-nosearch="" href="/#/i18n">
|
|
|
|
|
Translations
|
|
|
|
|
</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- App with its own nav, search and sidebar -->
|
|
|
|
|
<div id="app"></div>
|
|
|
|
|
<script>
|
|
|
|
|
window.$docsify = {
|
|
|
|
|
homepage: 'index',
|
|
|
|
|
|
|
|
|
|
relativePath: true,
|
|
|
|
|
// common aliases
|
|
|
|
|
alias: {
|
|
|
|
|
'.*/_navbar.md': '/_navbar.md',
|
|
|
|
|
'/i18n/?': '/_translations.md'
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
// break the caching
|
|
|
|
|
requestHeaders: {
|
|
|
|
|
'cache-control': 'no-cache'
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
// Cover Page
|
|
|
|
|
coverpage: true,
|
|
|
|
|
onlyCover: true,
|
|
|
|
|
|
|
|
|
|
// Navigation
|
|
|
|
|
autoHeader: true,
|
|
|
|
|
auto2top: true,
|
|
|
|
|
|
|
|
|
|
loadSidebar: true,
|
|
|
|
|
maxLevel: 2,
|
|
|
|
|
subMaxLevel: 2,
|
|
|
|
|
|
|
|
|
|
topMargin: 90,
|
2020-04-06 12:17:40 +00:00
|
|
|
|
2021-07-06 14:30:09 +00:00
|
|
|
// we do not use the built in navbar other then in mobile view
|
|
|
|
|
loadNavbar: true,
|
|
|
|
|
mergeNavbar: true,
|
|
|
|
|
|
|
|
|
|
// Plugins
|
|
|
|
|
search: {
|
|
|
|
|
depth: 3,
|
|
|
|
|
noData: 'No results!',
|
|
|
|
|
placeholder: 'Search...'
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
// Add languages here for message box translations
|
|
|
|
|
flexibleAlerts: {
|
2021-03-09 06:00:31 +00:00
|
|
|
note: {
|
|
|
|
|
label: {
|
|
|
|
|
'/i18n/chinese/': '注意',
|
|
|
|
|
'/i18n/espanol/': 'Nota',
|
2021-06-25 18:08:23 +00:00
|
|
|
'/i18n/italian/': 'Nota',
|
2021-08-04 15:06:27 +00:00
|
|
|
'/i18n/portuguese/': 'Observação',
|
2021-03-09 06:00:31 +00:00
|
|
|
'/': 'Note'
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
tip: {
|
|
|
|
|
label: {
|
|
|
|
|
'/i18n/chinese/': '提示',
|
|
|
|
|
'/i18n/espanol/': 'Sugerencia',
|
2021-06-25 18:08:23 +00:00
|
|
|
'/i18n/italian/': 'Suggerimento',
|
2021-08-04 15:06:27 +00:00
|
|
|
'/i18n/portuguese/': 'Dica',
|
2021-03-09 06:00:31 +00:00
|
|
|
'/': 'Tip'
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
warning: {
|
|
|
|
|
label: {
|
|
|
|
|
'/i18n/chinese/': '警告',
|
|
|
|
|
'/i18n/espanol/': 'Advertencia',
|
2021-06-25 18:08:23 +00:00
|
|
|
'/i18n/italian/': 'Avviso',
|
2021-08-04 15:06:27 +00:00
|
|
|
'/i18n/portuguese/': 'Aviso',
|
2021-03-09 06:00:31 +00:00
|
|
|
'/': 'Warning'
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
attention: {
|
|
|
|
|
label: {
|
|
|
|
|
'/i18n/chinese/': '注意',
|
|
|
|
|
'/i18n/espanol/': 'Atención',
|
2021-06-25 18:08:23 +00:00
|
|
|
'/i18n/italian/': 'Attenzione',
|
2021-08-04 15:06:27 +00:00
|
|
|
'/i18n/portuguese/': 'Atenção',
|
2021-03-09 06:00:31 +00:00
|
|
|
'/': 'Attention'
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
},
|
2020-04-06 12:17:40 +00:00
|
|
|
|
2021-07-06 14:30:09 +00:00
|
|
|
pagination: {
|
|
|
|
|
crossChapter: true
|
|
|
|
|
},
|
2020-10-03 22:24:52 +00:00
|
|
|
|
2021-07-06 14:30:09 +00:00
|
|
|
remoteMarkdown: {
|
|
|
|
|
tag: 'remote-markdown-url'
|
|
|
|
|
},
|
2020-10-01 22:37:20 +00:00
|
|
|
|
2021-10-12 15:19:18 +00:00
|
|
|
tabs: {
|
|
|
|
|
persist: true, // default
|
|
|
|
|
sync: true, // default
|
|
|
|
|
theme: 'classic', // default
|
|
|
|
|
tabComments: true, // default
|
|
|
|
|
tabHeadings: true // default
|
|
|
|
|
},
|
|
|
|
|
|
2021-07-06 14:30:09 +00:00
|
|
|
plugins: [
|
|
|
|
|
function (hook, vm) {
|
|
|
|
|
hook.beforeEach(function (markdown) {
|
|
|
|
|
// -- ignore the translations list page
|
|
|
|
|
if (vm.route.file === '_translations.md') return markdown;
|
|
|
|
|
|
|
|
|
|
// -- add "Update this translation" link for all i18n language pages
|
|
|
|
|
if (vm.route.path.search('i18n') !== -1) {
|
|
|
|
|
var dynamicText =
|
|
|
|
|
'[<i class="far fa-edit"></i> Update the translation](' +
|
|
|
|
|
'https://translate.freecodecamp.org/contributing-docs' +
|
|
|
|
|
') or [visit the English version](' +
|
|
|
|
|
'/' +
|
|
|
|
|
vm.route.path.split('/').pop() +
|
|
|
|
|
') of this guide to update instructions.';
|
2020-10-03 23:10:56 +00:00
|
|
|
}
|
|
|
|
|
|
2021-07-06 14:30:09 +00:00
|
|
|
// -- add "Edit this guide on GitHub" link for all English language pages
|
|
|
|
|
if (vm.route.path.search('i18n') === -1) {
|
|
|
|
|
var dynamicText =
|
|
|
|
|
'[<i class="far fa-edit"></i> Edit this guide on GitHub](' +
|
|
|
|
|
'https://github.com/freeCodeCamp/freeCodeCamp/blob/main/docs/' +
|
|
|
|
|
vm.route.file +
|
|
|
|
|
')';
|
2020-11-29 17:30:30 +00:00
|
|
|
}
|
2020-04-21 01:26:45 +00:00
|
|
|
|
2021-07-06 14:30:09 +00:00
|
|
|
// Used from https://github.com/ckoliber/docsify-rtl/blob/master/build/docsify-rtl.js,
|
|
|
|
|
// Currently this is a hack because can't use the plugin as is.
|
|
|
|
|
if (
|
|
|
|
|
vm.route.path.search('Arabic') !== -1 ||
|
|
|
|
|
vm.route.path.search('Hebrew') !== -1
|
|
|
|
|
) {
|
|
|
|
|
for (
|
|
|
|
|
var counter = 0,
|
|
|
|
|
elements =
|
|
|
|
|
document.getElementsByClassName('markdown-section');
|
|
|
|
|
counter < elements.length;
|
|
|
|
|
counter++
|
|
|
|
|
) {
|
|
|
|
|
var item = elements[counter];
|
|
|
|
|
item.dir = 'rtl';
|
|
|
|
|
}
|
|
|
|
|
}
|
2020-04-06 12:17:40 +00:00
|
|
|
|
2021-07-06 14:30:09 +00:00
|
|
|
if (
|
|
|
|
|
vm.route.path.search('Arabic') === -1 &&
|
|
|
|
|
vm.route.path.search('Hebrew') === -1
|
|
|
|
|
) {
|
|
|
|
|
for (
|
|
|
|
|
var counter = 0,
|
|
|
|
|
elements =
|
|
|
|
|
document.getElementsByClassName('markdown-section');
|
|
|
|
|
counter < elements.length;
|
|
|
|
|
counter++
|
|
|
|
|
) {
|
|
|
|
|
var item = elements[counter];
|
|
|
|
|
item.dir = 'ltr';
|
|
|
|
|
}
|
|
|
|
|
}
|
2020-10-22 10:38:04 +00:00
|
|
|
|
2021-07-06 14:30:09 +00:00
|
|
|
return markdown + '\n----\n' + dynamicText;
|
|
|
|
|
// -- do not add logic below this line --
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
};
|
|
|
|
|
</script>
|
2021-10-12 15:19:18 +00:00
|
|
|
<!-- docsify (latest v4.x.x)-->
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
|
|
|
|
|
<!-- docsify-tabs (latest v1.x.x) -->
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/docsify-tabs@1"></script>
|
2021-07-06 14:30:09 +00:00
|
|
|
|
|
|
|
|
<!-- Theme -->
|
|
|
|
|
<!-- <script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0"></script> -->
|
|
|
|
|
|
|
|
|
|
<!-- Plugins -->
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js"></script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js"></script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/docsify-copy-code@2"></script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/docsify-plugin-flexible-alerts@1"></script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/components/prism-jsx.min.js"></script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/components/prism-typescript.min.js"></script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/components/prism-tsx.min.js"></script>
|
2021-09-24 17:27:20 +00:00
|
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/components/prism-yaml.min.js"></script>
|
2021-07-06 14:30:09 +00:00
|
|
|
|
|
|
|
|
<script src="https://unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
|
|
|
|
|
<script src="https://unpkg.com/docsify-remote-markdown/dist/docsify-remote-markdown.min.js"></script>
|
|
|
|
|
|
|
|
|
|
<script
|
2021-08-09 10:50:16 +00:00
|
|
|
src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/js/all.min.js"
|
|
|
|
|
integrity="sha512-Tn2m0TIpgVyTzzvmxLNuqbSJH3JP8jm+Cy3hvHrW7ndTDcJ1w5mBiksqDBb8GpE2ksktFvDB/ykZ0mDpsZj20w=="
|
2021-07-06 14:30:09 +00:00
|
|
|
crossorigin="anonymous"
|
|
|
|
|
></script>
|
|
|
|
|
</body>
|
2021-03-09 06:00:31 +00:00
|
|
|
</html>
|
