qmk_firmware/newbs_git_best_practices.html

24 lines
97 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Best Git Practices for Working with QMK | QMK Firmware</title>
<meta name="description" content="Documentation for QMK Firmware">
<meta name="generator" content="VitePress v1.1.3">
<link rel="preload stylesheet" href="/assets/style.No8zk9aC.css" as="style">
<script type="module" src="/assets/app.27PKLiAG.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/theme.C3XzTLSh.js">
<link rel="modulepreload" href="/assets/chunks/framework.Clpp4x2N.js">
<link rel="modulepreload" href="/assets/newbs_git_best_practices.md.BQEFeFMK.lean.js">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar has-sidebar top" data-v-ae24b3ad data-v-ccf7ddec><div class="wrapper" data-v-ccf7ddec><div class="container" data-v-ccf7ddec><div class="title" data-v-ccf7ddec><div class="VPNavBarTitle has-sidebar" data-v-ccf7ddec data-v-ab179fa1><a class="title" href="/" data-v-ab179fa1><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/qmk-logo-dark.svg" alt data-v-8426fc1a><!--]--><!--[--><img class="VPImage light logo" src="/qmk-logo-light.svg" alt data-v-8426fc1a><!--]--><!--]--><!--]--><span data-v-ab179fa1>QMK Firmware</span><!--[--><!--]--></a></div></div><div class="content" data-v-ccf7ddec><div class="content-body" data-v-ccf7ddec><!--[--><!--]--><div class="VPNavBarSearch search" data-v-ccf7ddec><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-ccf7ddec data-v-7f418b0f><span id="main-nav-aria-label" class="visually-hidden" data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/" tabindex="0" data-v-7f418b0f data-v-9c663999><!--[--><span data-v-9c663999>Home</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-ccf7ddec data-v-e6aabb21><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-e6aabb21 data-v-d1f28634 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-d1f28634></span><span class="vpi-moon moon" data-v-d1f28634></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-ccf7ddec data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://reddit.com/r/olkb" aria-label target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50" width="50px" height="50px"><path d="M 29 3 C 28.0625 3 27.164063 3.382813 26.5 4 C 25.835938 4.617188 25.363281 5.433594 25 6.40625 C 24.355469 8.140625 24.085938 10.394531 24.03125 13.03125 C 19.234375 13.179688 14.820313 14.421875 11.28125 16.46875 C 10.214844 15.46875 8.855469 14.96875 7.5 14.96875 C 6.089844 14.96875 4.675781 15.511719 3.59375 16.59375 C 1.425781 18.761719 1.425781 22.238281 3.59375 24.40625 L 3.84375 24.65625 C 3.3125 26.035156 3 27.488281 3 29 C 3 33.527344 5.566406 37.585938 9.5625 40.4375 C 13.558594 43.289063 19.007813 45 25 45 C 30.992188 45 36.441406 43.289063 40.4375 40.4375 C 44.433594 37.585938 47 33.527344 47 29 C 47 27.488281 46.6875 26.035156 46.15625 24.65625 L 46.40625 24.40625 C 48.574219 22.238281 48.574219 18.761719 46.40625 16.59375 C 45.324219 15.511719 43.910156 14.96875 42.5 14.96875 C 41.144531 14.96875 39.785156 15.46875 38.71875 16.46875 C 35.195313 14.433594 30.800781 13.191406 26.03125 13.03125 C 26.09375 10.546875 26.363281 8.46875 26.875 7.09375 C 27.164063 6.316406 27.527344 5.757813 27.875 5.4375 C 28.222656 5.117188 28.539063 5 29 5 C 29.460938 5 29.683594 5.125 30.03125 5.40625 C 30.378906 5.6875 30.785156 6.148438 31.3125 6.6875 C 32.253906 7.652344 33.695313 8.714844 36.09375 8.9375 C 36.539063 11.238281 38.574219 13 41 13 C 43.75 13 46 10.75 46 8 C 46 5.25 43.75 3 41 3 C 38.605469 3 36.574219 4.710938 36.09375 6.96875 C 34.3125 6.796875 33.527344 6.109375 32.75 5.3125 C 32.300781 4.851563 31.886719 4
<script>window.__VP_HASH_MAP__=JSON.parse("{\"capabilities_inc.md\":\"IeyuI9Wf\",\"api_development_environment.md\":\"BdPW5Xxm\",\"changelog_20190830.md\":\"Bivr4BOW\",\"faq_build.md\":\"DgVYb8Zh\",\"cli.md\":\"BmxhRPcP\",\"drivers_aw20216s.md\":\"BIfeX9RQ\",\"newbs_learn_more_resources.md\":\"DJeo5kRX\",\"newbs_testing_debugging.md\":\"DIfKsMTC\",\"one_shot_keys.md\":\"DG5UoHI0\",\"drivers_is31fl3742a.md\":\"Cjvb_b-G\",\"changelog_20201128.md\":\"Bv3MtRZN\",\"other_vscode.md\":\"BDsv-WIr\",\"platformdev_blackpill_f4x1.md\":\"BvgwJuB9\",\"drivers_i2c.md\":\"Dr29Qpwd\",\"platformdev_chibios_earlyinit.md\":\"BKgGp6Ev\",\"drivers_is31fl3218.md\":\"CbXgZf0f\",\"platformdev_proton_c.md\":\"65AUzKpy\",\"drivers_is31fl3236.md\":\"DB6z91iZ\",\"drivers_is31fl3729.md\":\"D51u1Zj1\",\"drivers_is31fl3731.md\":\"BAADR_YT\",\"drivers_is31fl3733.md\":\"DkzQC1rk\",\"drivers_is31fl3736.md\":\"D-ShjYav\",\"drivers_is31fl3737.md\":\"BqpmIJMQ\",\"other_eclipse.md\":\"CWb0jnQC\",\"arm_debugging.md\":\"DVeULkLA\",\"changelog_20220827.md\":\"CV9uGcQ3\",\"features_leader_key.md\":\"Nmog5Zz4\",\"changelog_20211127.md\":\"Dnz3u-H6\",\"changelog_20240526.md\":\"CmS3Cuz0\",\"changelog_20200530.md\":\"JEJG56LT\",\"features_rawhid.md\":\"a2O7n8yI\",\"configurator_architecture.md\":\"CmFDpVLe\",\"flashing.md\":\"CK6oObIF\",\"getting_started_docker.md\":\"dHxmuSds\",\"getting_started_github.md\":\"EVx9Hm-S\",\"getting_started_introduction.md\":\"BTOrKqLL\",\"getting_started_make_guide.md\":\"snyKLkVb\",\"hand_wire.md\":\"B69NBeYw\",\"hardware_drivers.md\":\"DA73-xWQ\",\"features_bootmagic.md\":\"DIHkTTz1\",\"features_digitizer.md\":\"DBSZvpwE\",\"features_sequencer.md\":\"F43NF6hh\",\"features_dip_switch.md\":\"CfJ3EvxZ\",\"features_dynamic_macros.md\":\"ZTtIhM8T\",\"features_space_cadet.md\":\"D3jhCzMk\",\"driver_installation_zadig.md\":\"Dy2kYHSK\",\"capabilities.md\":\"BPL75VHK\",\"features_swap_hands.md\":\"ChjoVx_w\",\"api_overview.md\":\"BzzvVapY\",\"features_encoders.md\":\"CugXBk-4\",\"features_grave_esc.md\":\"DTvs6396\",\"drivers_serial.md\":\"CDjOJdNt\",\"api_development_overview.md\":\"BZJTSE_s\",\"features_haptic_feedback.md\":\"DVUdhF3q\",\"drivers_adc.md\":\"B7GhN9cb\",\"breaking_changes_instructions.md\":\"C9StPyYH\",\"features_hd44780.md\":\"kUIf1-0D\",\"drivers_is31fl3743a.md\":\"C7TkCrlE\",\"features_key_lock.md\":\"CXEQ5-MN\",\"features_joystick.md\":\"D4eaz8gV\",\"drivers_apa102.md\":\"DRKqdW0M\",\"newbs_building_firmware_workflow.md\":\"CiP7v8Cc\",\"data_driven_config.md\":\"3iL4-P4O\",\"keycodes_magic.md\":\"LOQRAy94\",\"easy_maker.md\":\"CW6jlMO-\",\"documentation_best_practices.md\":\"CsnEVROI\",\"drivers_is31fl3741.md\":\"9e7jzvwW\",\"mod_tap.md\":\"B5t5NSBO\",\"newbs.md\":\"BD3QefyC\",\"newbs_building_firmware.md\":\"CybovRdt\",\"newbs_building_firmware_configurator.md\":\"BwSLgipx\",\"newbs_external_userspace.md\":\"BMYQp9mN\",\"keycodes_basic.md\":\"B_iSDgm4\",\"features_audio.md\":\"Dy0ToeLW\",\"configurator_step_by_step.md\":\"CQWwPq1x\",\"contributing.md\":\"C-zh8zuX\",\"custom_matrix.md\":\"BaJLCNe_\",\"changelog_20200829.md\":\"Dkrt3arz\",\"changelog_20230226.md\":\"BhryCt4E\",\"drivers_spi.md\":\"DoCZg1iV\",\"drivers_uart.md\":\"gh92qK6t\",\"features_programmable_button.md\":\"C7mT83XS\",\"coding_conventions_python.md\":\"CssZF_dh\",\"features_combo.md\":\"CC9QZAP7\",\"chibios_upgrade_instructions.md\":\"DIU6p99M\",\"drivers_ws2812.md\":\"C97W5Kwr\",\"faq_debug.md\":\"BDXERRoT\",\"features_autocorrect.md\":\"CrKw5pKP\",\"features_ps2_mouse.md\":\"CR0p8T4u\",\"custom_quantum_functions.md\":\"DtIuNxTQ\",\"features_led_indicators.md\":\"Cnu82Paw\",\"changelog_20200229.md\":\"BlwjdGdl\",\"faq_keymap.md\":\"DIjgUAJ7\",\"features_stenography.md\":\"BmdUwUEg\",\"feature_layouts.md\":\"Cjp6pYRh\",\"changelog_20230827.md\":\"hs0Cz5za\",\"hardware_keyboard_guidelines.md\":\"M0UlpwHv\",\"features_bluetooth.md\":\"Bs2LdUw_\",\"feature_advanced_keycodes.md\":\"BI-acvLB\",\"feature_debounce_type.md\":\"DBjOROev\",\"drivers_is31fl3745.md\":\"D5R_sxfC\",\"feature_eeprom.md\":\"tGEc5qB_\",\"features_rgb_matrix.md\":\"C0kYzT0E\",\
</body>
</html>