streaming

Media streaming and broadcast systems in Go
Log | Files | Refs | README | LICENSE

README.md (2953B)

      1 [![pkgsite](https://pkg.go.dev/badge/github.com/untangledco/streaming)](https://pkg.go.dev/github.com/untangledco/streaming)
      2 [![0 dependencies!](https://www.olowe.co/0.svg)](https://0dependencies.dev)
      3 
      4 This repository contains packages for developing media streaming systems in Go.
      5 Watch it being developed live!
      6 
      7 - [twitch.tv/untangledco]
      8 - [youtube.com/@untangledco]
      9 
     10 We used to use these packages to self-host the livestream,
     11 but the dayjob prevents me from streaming often enough to keep the
     12 server running.
     13 
     14 [twitch.tv/untangledco]: https://twitch.tv/untangledco
     15 [youtube.com/@untangledco]: https://www.youtube.com/@untangledco
     16 
     17 ## Contributing
     18 
     19 ### Stuff to do
     20 
     21 Larger, fleshed-out tasks are managed in [issues].
     22 
     23 There are `TODO` notes in the source code, too.
     24 [godoc] provides a graphic interface to view these with the `-notes`
     25 flag:
     26 
     27 	godoc -notes TODO
     28 
     29 Of course `grep` works too:
     30 
     31 	git grep -n TODO
     32 
     33 [godoc]: https://pkg.go.dev/golang.org/x/tools/cmd/godoc
     34 [issues]: https://github.com/untangledco/streaming/issues
     35 
     36 ### Patches
     37 
     38 Patches are preferred via email so that we're not too locked in to GitHub.
     39 Post them to the mailing list
     40 [~otl/untangledco@lists.sr.ht] ([archives]).
     41 or to [Oliver Lowe].
     42 See [git-send-email.io] if you're unfamiliar with the workflow.
     43 
     44 	git config sendemail.to '~otl/untangledco@lists.sr.ht'
     45 
     46 We also accept changes via [pull request].
     47 
     48 ### Commit messages
     49 
     50 Commit messages follow the same format used by the [Go] project (and others).
     51 The commit subject starts with the affected package name then a brief description of the change.
     52 The body may contain an explanation of the change and why it was made.
     53 For example:
     54 
     55 	sdp: store attributes as key-value pairs
     56 
     57 	This matches what the spec allows, and lets users not worry about
     58 	encoding.
     59 
     60 [archives]: https://lists.sr.ht/~otl/untangledco
     61 [~otl/untangledco@lists.sr.ht]: mailto:~otl/untangledco@lists.sr.ht
     62 [git-send-email.io]: https://git-send-email.io
     63 [pull request]: https://github.com/untangledco/streaming/pulls
     64 
     65 ### Code review
     66 
     67 We try to make all code feel familiar to Go programmers
     68 so that it's easier for others to learn from and contribute to in the
     69 future.
     70 
     71 In general we follow the guidelines laid out in the following articles:
     72 
     73 - [Effective Go]
     74 - [Go Code Review Comments]
     75 
     76 Don't worry if you're asked about changing things around!
     77 If there are trivial changes, we may make the changes ourselves.
     78 In this case you still retain all authorship and copyright over your
     79 submission.
     80 
     81 If you've read this far and want to join in but feel a little unsure;
     82 I know *exactly* how you feel.
     83 Please feel free to email [Oliver Lowe] and maybe I can help out :)
     84 
     85 [Effective Go]: https://go.dev/doc/effective_go
     86 [Go Code Review Comments]: https://go.dev/wiki/CodeReviewComments
     87 [Go]: https://go.dev/doc/contribute#commit_messages
     88 [Oliver Lowe]: mailto:o@olowe.co
     89 
     90 ## License
     91 
     92 Unless otherwise noted, this sotfware is licensed under the ISC License.
     93 See LICENSE.