summaryrefslogtreecommitdiff
path: root/docs/contributing.md
AgeCommit message (Collapse)Author
2019-12-18Improve docs "Edit Document" footerfauxpark
2019-11-23Set up language fallback for docs, and update translation guidelines (#7403)fauxpark
* 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
2019-10-07[Docs] Add an important note about modifying user code (#6959)fauxpark
* Add an important note about modifying user code * Update docs/contributing.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-07-15QMK CLI and JSON keymap support (#6176)skullydazed
* 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
2019-04-18Update our style guide (#5500)skullydazed
* Update our style guide * Clarify muiltple condition ifs * update the ifdef section
2019-03-07[Docs] Add Tap Dance example to the docs (#5326)Dusty Pomerleau
* 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
2019-02-26Ask for your name when generating a new keyboard (#5214)fauxpark
* Ask for your name when generating a new keyboard * Update docs * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-02-17Add clang-format section to contributing.mdJames Churchill
2018-10-06Update Contrib doc (#4068)Drashna Jaelre
* Add link for style * ignore java * Add example and update link? * Minor fixes * Change 1TBS text * comments
2018-09-15docs/contributing: add `#pragma once` to Coding ConventionsJames Laird-Wah
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.
2018-07-11Replace gitter links with Discord. (#3368)Fred Silberberg
2018-05-24Fix readme and contributing hyperlinksAlexander Dang-Tran
2017-12-09Trim trailing whitespacefauxpark
2017-12-09Fix some of the more obvious typosfauxpark
2017-12-09Convert all headings to Title Casefauxpark
2017-11-30Fix internal links in docs/ (#2080)Devin J. Pohly
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.
2017-11-01update contributing guidelinesJack Humbert
2017-10-24Restructure the hardware and feature docs to make things easier to find (#1888)skullydazed
* fix #1313 by documenting more config.h options * Clean up and organize documentation
2017-10-21Fix the naming for clueboard filesskullY
2017-10-14Make arguments redo, subproject elimination (#1784)Jack Humbert
* 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
2017-10-11Fix the presentation of the contribution guideskullY