Menu

Read this if you want to contribute to the Jamulus source code

2020-05-19
2021-02-18
  • Volker Fischer

    Volker Fischer - 2020-05-19

    If you plan to contribute to the Jamulus source code, please read the following list:

    • Before you start coding create a Github issue at https://github.com/corrados/jamulus/issues . In that new issue write your specification and that you are planning to do the coding. Then we can discuss the specification. Only start coding after we agreed to a specification.
    • If the Github issue for your feature/bug fix already exists, then write a message in that issue that you want to work on it.
    • Respect the existing code style.
    • Tab size=4, insert spaces.
    • Make sure (if possible) that your code compiles on Windows/Mac/Linux.
    • Do not use diff/patch to send your code changes but create a Github fork of the Jamulus code and create a Pull Request when you are done.
     
  • Alex Buckland

    Alex Buckland - 2020-06-04

    Oops, just found this. Hopefully you don't require an issue to fix a 1 character typo :)

     
  • Edgar Sche

    Edgar Sche - 2020-06-08

    are there any code documentations available? I'm looking forward to dig a little bit deeper into this project so that I could add some new features and integrate it with different programs. 

    I'm looking for any form of diagrams (UML, Class, Sequence, etc.) and explanations for certain components of the code like:

    • Audio Buffers

    • Audio Coding & Decoding

    • Server side mixing of the Audio Streams

    • Communication between Servers 

    • Overview of the architecture

    It would be really nice if someone could give me a little bit more insight on the source code.