summaryrefslogtreecommitdiffstats
path: root/docs/contributing.md
Commit message (Collapse)AuthorAgeFilesLines
* Breaking changes changelog, 2023q3 version (#21848)Nick Brassel2023-08-291-13/+3
| | | | | | Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: honorless <86894501+lesshonor@users.noreply.github.com>
* Contributing docs: add note to make sure repo is up to date (#21694)Ryan2023-08-051-0/+1
|
* Minor cleanup to breaking/checklist docs. (#19596)Nick Brassel2023-01-191-3/+3
| | | Co-authored-by: Ryan <fauxpark@gmail.com>
* update the Chinese translation based on the latest English version (#14924)IskandarMa2022-01-181-2/+2
| | | | | | Co-authored-by: peepeetee <43021794+peepeetee@users.noreply.github.com> Co-authored-by: Joy Lee <chang.li@westberrytech.com> Co-authored-by: LitoMore <LitoMore@users.noreply.github.com> Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
* Remove bin/qmk (#14231)Zach White2021-08-291-1/+1
| | | | | * Remove the bin/qmk script * remove bin/qmk from workflows
* [Core] [Docs] Remove travis-ci references (#13916)Spaceman2021-08-201-1/+1
|
* [Docs] Use HTTPS for images and links where possible (#11695)Ryan2021-01-301-1/+1
|
* Add explicit id tags to externally linked headersskullY2020-03-051-1/+1
|
* Improve docs "Edit Document" footerfauxpark2019-12-181-1/+1
|
* Set up language fallback for docs, and update translation guidelines (#7403)fauxpark2019-11-231-0/+12
| | | | | | | | | | | | | | * Set up language fallback for docs, and update translation guidelines * Title Case * Add ID example * Link to emoji flag cheatsheet * Move docs preview section to contributing.md * Point to docs preview in the readme
* [Docs] Add an important note about modifying user code (#6959)fauxpark2019-10-071-3/+5
| | | | | | | | * Add an important note about modifying user code * Update docs/contributing.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* QMK CLI and JSON keymap support (#6176)skullydazed2019-07-151-55/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Script to generate keymap.c from JSON file. * Support for keymap.json * Add a warning about the keymap.c getting overwritten. * Fix keymap generating * Install the python deps * Flesh out more of the python environment * Remove defunct json2keymap * Style everything with yapf * Polish up python support * Hide json keymap.c into the .build dir * Polish up qmk-compile-json * Make milc work with positional arguments * Fix a couple small things * Fix some errors and make the CLI more understandable * Make the qmk wrapper more robust * Add basic QMK Doctor * Clean up docstrings and flesh them out as needed * remove unused compile_firmware() function
* Update our style guide (#5500)skullydazed2019-04-181-1/+9
| | | | | | | | * Update our style guide * Clarify muiltple condition ifs * update the ifdef section
* [Docs] Add Tap Dance example to the docs (#5326)Dusty Pomerleau2019-03-071-0/+14
| | | | | | | | * add a tapdance example for creating advanced mod-tap and layer-tap keys * add optional curly braces to match QMK conventions * change example to use `register_code16()` and tapdance keycodes more closely matching QMK variants
* Ask for your name when generating a new keyboard (#5214)fauxpark2019-02-261-2/+2
| | | | | | | | | | * Ask for your name when generating a new keyboard * Update docs * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Add clang-format section to contributing.mdJames Churchill2019-02-171-0/+12
|
* Update Contrib doc (#4068)Drashna Jaelre2018-10-061-2/+21
| | | | | | | | | | | | | | * Add link for style * ignore java * Add example and update link? * Minor fixes * Change 1TBS text * comments
* docs/contributing: add `#pragma once` to Coding ConventionsJames Laird-Wah2018-09-151-0/+1
| | | | | | This supersedes the older include guard mechanism since all the compilers now support it. It's easier for new users and less prone to error.
* Replace gitter links with Discord. (#3368)Fred Silberberg2018-07-111-3/+3
|
* Fix readme and contributing hyperlinksAlexander Dang-Tran2018-05-241-3/+3
|
* Trim trailing whitespacefauxpark2017-12-091-3/+3
|
* Fix some of the more obvious typosfauxpark2017-12-091-1/+1
|
* Convert all headings to Title Casefauxpark2017-12-091-6/+6
|
* Fix internal links in docs/ (#2080)Devin J. Pohly2017-11-301-1/+1
| | | | One link in the summary (Modding your keyboard) referred to a page that was deleted; the rest have been updated to point to the new names.
* update contributing guidelinesJack Humbert2017-11-011-0/+5
|
* Restructure the hardware and feature docs to make things easier to find (#1888)skullydazed2017-10-241-1/+1
| | | | | | * fix #1313 by documenting more config.h options * Clean up and organize documentation
* Fix the naming for clueboard filesskullY2017-10-211-1/+1
|
* Make arguments redo, subproject elimination (#1784)Jack Humbert2017-10-141-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * start to update readmes and keyboards * look in keyboard directories for board.mk * update visualizer rules * fix up some other keyboards/keymaps * fix arm board ld includes * fix board rules * fix up remaining keyboards * reset layout variable * reset keyboard_layouts * fix remainging keymaps/boards * update readmes, docs * add note to makefile error * update readmes * remove planck keymap warnings * update references and docs * test out tarvis build stages * don't use stages for now * don't use stages for now
* Fix the presentation of the contribution guideskullY2017-10-111-0/+147
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-21 16:14:45 +0000