Преглед изворни кода

Updated readme with information on contributing.

arianagiroux пре 1 месец
родитељ
комит
ba662a5dec
1 измењених фајлова са 16 додато и 5 уклоњено
  1. 16 5
      Readme.md

+ 16 - 5
Readme.md

@@ -21,8 +21,7 @@ bubble := pingo.InitialPeakModel()
  - `ping.go:// TODO(performance): implement ping message channel buffering`
  - `tui.go:// TODO(chart): dynamically render charts to fit height on not set`
  - `tui.go:// TODO(styling): allow end user to define their own styles when hacking.`
-
- - [ ] "scroll peek" refinements
+ - "scroll peek" refinements
 
 ## Core
 
@@ -35,7 +34,7 @@ bubble := pingo.InitialPeakModel()
 
  - [ ] Implement peak and average models (currently implemented: peak)
 
-## resources
+## Developer resources
 
 | resource        | use                                |
 |-----------------|------------------------------------|
@@ -44,7 +43,7 @@ bubble := pingo.InitialPeakModel()
 | [bubbles][bbl]  | widget lib for bubbletea           |
 | [ntcharts][ntc] | chart widgets for bubbletea        |
 
-### proposed color palette
+### Proposed color palette
 
 | base      | lower     | middle    | secondary | primary   |
 |-----------|-----------|-----------|-----------|-----------|
@@ -54,11 +53,23 @@ bubble := pingo.InitialPeakModel()
 
 All commits are subject to the AGPL3
 
+## Contributions
+
+To contribute changes:
+
+ - commit any changes to a publicly accessible git repository.
+ - send the contents of `git request-pull` to `pingo-dev@googlegroups.com`
+
+To report an issue or suggest a feature:
+
+ - send any relevant information, including (if possible) the installed
+   release, to pingo-dev@googlegroups.com
+
 [bt]: https://github.com/charmbracelet/bubbletea
 [lg]: https://github.com/charmbracelet/lipgloss
 [bbl]: charm.land/bubbles/v2
 [ntc]: https://github.com/NimbleMarkets/ntcharts
 [wish]: https://github.com/charmbracelet/wish
-[issues-go]: ssh://git/issues-go.git
+[issues-go]: https://git.crowcollective.space/arianagiroux/issues-go
 
 [](vim: nowrap)