diff options
| author | skullY <skullydazed@gmail.com> | 2017-08-06 20:57:57 -0700 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-08-16 15:47:20 -0400 |
| commit | 9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a (patch) | |
| tree | 352da3e60b219405be323306bcd67a6729107d61 /docs/adding_features_to_qmk.md | |
| parent | 9b879b1267cd5cbebf4d73595c7ca4ed52fe5ef4 (diff) | |
| download | firmware-9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a.tar.gz firmware-9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a.tar.bz2 firmware-9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a.zip | |
Doc updates from going through every file
Diffstat (limited to 'docs/adding_features_to_qmk.md')
| -rw-r--r-- | docs/adding_features_to_qmk.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/adding_features_to_qmk.md b/docs/adding_features_to_qmk.md index fb036496c..e031ddbb7 100644 --- a/docs/adding_features_to_qmk.md +++ b/docs/adding_features_to_qmk.md @@ -11,6 +11,6 @@ Once you have implemented your new feature you will generally submit a [pull req * **Disabled by default** - memory is a pretty limited on most chips QMK supports, and it's important that current keymaps aren't broken, so please allow your feature to be turned **on**, rather than being turned off. If you think it should be on by default, or reduces the size of the code, please talk with us about it. * **Compile locally before submitting** - hopefully this one is obvious, but things need to compile! Our Travis system will catch any issues, but it's generally faster for you to compile a few keyboards locally instead of waiting for the results to come back. -* **Consider subprojects and different chip-bases** - there are several keyboards that have subprojects that have allow for slightly different configurations, and even different chip-bases. Try to make a feature supported in ARM and AVR, or automatically disabled in one that doesn't work. +* **Consider subprojects and different chip-bases** - there are several keyboards that have subprojects that allow for slightly different configurations, and even different chip-bases. Try to make a feature supported in ARM and AVR, or automatically disabled on platforms it doesn't work on. * **Explain your feature** - Document it in `docs/`, either as a new file or as part of an existing file. If you don't document it other people won't be able to benefit from your hard work. -* **Don't refactor code** - to maintain a clear vision of how things are laid out in QMK, we try to plan out refactors in-depth, and have a collaborator make the changes. If you have an idea for refactoring, or suggestions, [open an issue](https://github.com/qmk/qmk_firmware/issues). +* **Don't refactor code** - to maintain a clear vision of how things are laid out in QMK, we try to plan out refactors in-depth, and have a collaborator make the changes. If you have an idea for refactoring, or suggestions, [open an issue](https://github.com/qmk/qmk_firmware/issues), we'd love to talk about how QMK can be improved. |