From c2edbad0fb1ff0d2acc26b70b5ca2a5c96cd3cee Mon Sep 17 00:00:00 2001 From: Ken Van Hoeylandt Date: Sat, 25 Jan 2025 12:35:28 +0100 Subject: [PATCH] Update CONTRIBUTING.md (#186) --- CONTRIBUTING.md | 53 +++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 47 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index be881e99..f9791f07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,52 @@ -# Note +# Contributing -During the pre-alpha stage, the APIs are changing rapidly. -I don't want to disappoint people with huge merge conflicts, so new features are not accepted yet. +## Accepted changes -I welcome fixes and possibly also board implementations: -Please open an [Issue](https://github.com/ByteWelder/Tactility/issues/new) on GitHub to discuss first new boards! +Before releasing version 1.0.0, the APIs are changing rapidly. +I want to minimize the amount of changes that I have to maintain, because it limits the amount of breaking changes that I have to deal with when the APIs change. -# Code Style +### New features + +These are currently not accepted. + +### Visual / interaction design changes + +These are currently not accepted. I'm aware that there is a lot of room for improvement, but I want to mainly focusing on strong technical foundations before +I start building further on top of that. +Feel free to open an [issue](https://github.com/ByteWelder/Tactility/issues/new) to discuss ideas you have, if you feel like they will have a considerable impact. + +### Fixing things + +The general take here is that minor changes are not accepted at this stage. I don't want to spend my time reviewing and discussing these during the current stage of the project. + +Only fixes for serious issues are accepted, like: +- Bugs +- Crashes +- Security issues + +Some examples of non-serious issues include: +- Documentation changes +- Renaming code +- Fixes for compiler warnings that have low impact on the actual application logic (e.g. only happens on simulator when calling a logging function) + +### New board implementations + +I only support boards that I also own. If I don't own a board, I can't properly test the reliability of the firmware. +If you wish to send me a board, please [contact me](https://tactility.one/#/support). + +Please open an [issue](https://github.com/ByteWelder/Tactility/issues/new) on GitHub to discuss new boards. + +If you implemented a board yourself, I'm willing to refer to your implementation on the main website. Please [contact me](https://tactility.one/#/support). + +### Anything that doesn't fall in the above categories? + +Please [contact me](https://tactility.one/#/support)a me first! + +## Pull Requests + +Pull requests should only contain a single set of changes that are related to eachother. +That way, an approved set of changes will not be blocked by an unapproved set of changes. + +## Code Style See [this document](CODING_STYLE.md) and [.clang-format](.clang-format).