2016-02-19 05:25:34 +00:00
|
|
|
<!-- vim: set tw=120: -->
|
|
|
|
|
|
|
|
|
|
# Contributing
|
|
|
|
|
|
2016-12-27 17:43:43 +00:00
|
|
|
Firstly, thanks for reading this. Pull requests, bug reports, feature requests, questions, etc. are all very welcome --
|
|
|
|
|
including ones from non-developers.
|
2016-02-19 05:25:34 +00:00
|
|
|
|
2016-12-27 17:43:43 +00:00
|
|
|
## Issues
|
2016-04-29 02:04:10 +00:00
|
|
|
|
2016-12-27 17:43:43 +00:00
|
|
|
You'll probably want to update to the latest version of the code before creating an issue. The easiest way is to just
|
2016-12-27 18:00:52 +00:00
|
|
|
run the installation command from [README.md](/README.md#install) again. (But `git pull && ./build_and_install.sh` is
|
|
|
|
|
faster.)
|
2016-04-29 02:04:10 +00:00
|
|
|
|
2016-12-27 17:43:43 +00:00
|
|
|
For bug reports about `build_and_install.sh`, please include your `build_and_install.log`. It should be saved in the
|
|
|
|
|
directory `build_and_install.sh` is in.
|
2016-04-29 02:04:10 +00:00
|
|
|
|
2016-12-27 17:43:43 +00:00
|
|
|
It might also be helpful to include logs in bug reports about Background Music itself. Those logs go to syslog by
|
|
|
|
|
default, so you can use Console.app to read them. (It might help to search for "BGM" or "Background Music".)
|
|
|
|
|
|
|
|
|
|
You also might not get any log messages at all. Normally (i.e. in release builds) Background Music only logs errors and
|
|
|
|
|
warnings. We're still working on adding optional debug-level logging to release builds.
|
|
|
|
|
|
|
|
|
|
If you feel like being really helpful, you could reproduce your bug with a debug build and include the debug logs, which
|
|
|
|
|
are much more detailed. But don't feel obligated to. To install a debug build, use `./build_and_install.sh -d`.
|
|
|
|
|
|
|
|
|
|
If you make an issue and you're interested in implementing/fixing it yourself, mention that in the issue so we can
|
|
|
|
|
confirm you're on the right track, assign the issue to you and so on.
|
|
|
|
|
|
|
|
|
|
## Code
|
2016-04-29 02:04:10 +00:00
|
|
|
|
2016-02-19 05:25:34 +00:00
|
|
|
The code is mostly C++ and Objective-C. But don't worry if you don't know those languages--I don't either. Or Core
|
2016-12-27 17:43:43 +00:00
|
|
|
Audio, for that matter. Also don't worry if you're not sure your code is right.
|
|
|
|
|
|
|
|
|
|
No dependencies so far. (Though you're welcome to add some.)
|
2016-02-19 05:25:34 +00:00
|
|
|
|
2016-12-27 17:43:43 +00:00
|
|
|
The best place to start is probably [DEVELOPING.md](/DEVELOPING.md), which has an overview of the project and
|
|
|
|
|
instructions for building, debugging, etc. It's kind of long, though, and not very interesting, so you might prefer to
|
|
|
|
|
go straight into the code. In that case, you'll probably want to start with
|
|
|
|
|
[AppDelegate.mm](/BGMApp/BGMApp/AppDelegate.mm).
|
2016-02-19 05:25:34 +00:00
|
|
|
|
2016-12-27 17:43:43 +00:00
|
|
|
If you get stuck or have questions about the project, feel free to open an issue. You could also [email
|
|
|
|
|
me](mailto:kyle@bearisdriving.com) or try [#backgroundmusic on
|
|
|
|
|
Freenode](https://webchat.freenode.net/?channels=backgroundmusic).
|
2016-02-19 05:25:34 +00:00
|
|
|
|
2016-12-27 17:43:43 +00:00
|
|
|
If you have questions related to Core Audio, the [Core Audio mailing
|
2016-02-19 05:25:34 +00:00
|
|
|
list](https://lists.apple.com/archives/coreaudio-api) is very useful. There's also the [Core Audio
|
|
|
|
|
Overview](https://developer.apple.com/library/mac/documentation/MusicAudio/Conceptual/CoreAudioOverview/Introduction/Introduction.html)
|
|
|
|
|
and the [Core Audio
|
|
|
|
|
Glossary](https://developer.apple.com/library/mac/documentation/MusicAudio/Reference/CoreAudioGlossary/Glossary/core_audio_glossary.html).
|
|
|
|
|
|
|
|
|
|
|
