UNPKG

@mxtommy/kip

Version:

An advanced and versatile marine instrumentation package to display Signal K data.

github.com/mxtommy/Kip

mxtommy/Kip

63 lines (43 loc) • 2.74 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
## Get in Touch We’d love to hear from you. The KIP community is active and friendly—whether you are just getting started, troubleshooting an installation, or brainstorming a new idea. 👉 **Chat with the community in the [KIP Discord channel](https://discord.gg/AMDYT2DQga).** Use Discord for quick questions, sharing dashboards, comparing hardware setups, and learning how others integrate KIP with Signal K. ## When to Use GitHub Issues Please open a GitHub issue anytime you: - Want to request a feature or enhancement - Find a bug or regression - Notice incorrect documentation - Have a reproducible performance or stability problem 🔗 **Create or review issues here: [KIP GitHub Issues](https://github.com/mxtommy/Kip/issues)** Before creating a new issue: 1. Use the search box to see if it already exists (add keywords like the widget name, setting, or error text). 2. If you find an existing issue, add a comment or reaction instead of opening a duplicate. ### What to Include in a Bug Report Provide clear, specific details so we can reproduce and fix the problem faster: - What you expected vs. what happened - Steps to reproduce (numbered list if possible) - KIP version (see About / build info) and deployment method (e.g. Signal K app store, manual build) - Signal K server version - Browser + version (e.g. Firefox 128, Chrome 129, Safari 18) - Relevant widget(s) or data paths (e.g. `navigation.speedOverGround`) - Screenshots or a short GIF (if visual) - Console errors (from browser dev tools) if any ### Feature Requests Tell us: - The problem you want to solve (not only the solution you imagine) - Why it matters / how it improves use onboard - Any related Signal K paths or data sources - Rough idea of UI needs (new widget? setting? config option?) If you’re willing to help test or prototype—say so. That speeds things up. ## Response Expectations - Discord: often same-day community responses; core maintainer availability may vary. - GitHub issues: triage typically within a few days; complex features may be discussed before acceptance. - Pull requests: reviews depend on scope—small fixes are faster. If something critical slips through, feel free to politely bump the issue after about a week. ## Contributing Beyond Issues - Share dashboards, layouts, or usage patterns. Use the Discord #showcase chanel with a few pictures (great inspiration for others!). - Help answer other users’ questions on Discord. - Test new widgets or configuration flows and give feedback. ## Thank You Your feedback, curiosity, and ideas directly shape KIP. Whether it’s a tiny typo fix or a major feature concept—every contribution moves the project forward. Fair winds, and happy hacking.