Tactility/CONTRIBUTING.md
Ken Van Hoeylandt f85d0239ff
Board implementations and fixes (#247)
- Implemented Elecrow Crowpanel Basic 5.0"
- Implemented Elecrow Crowpanel Advance 5.0"
- Implemented CYD 2432S032C
- Fix for CYD 4848S040C rendering drift (lower transfer speed)
- Fix for SD card locking mechanism for various boards
2025-03-14 22:37:09 +01:00

1.7 KiB

Contributing

Accepted changes

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.

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 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

Please open an issue on GitHub to discuss new boards.

Anything that doesn't fall in the above categories?

Please contact me first!

Pull Requests

Pull requests should only contain a single set of changes that are related to each other. That way, an approved set of changes will not be blocked by an unapproved set of changes.

Code Style

See this document and .clang-format.