Developer documentation, please
There is no readme, no list of dependencies or anything else that would help a willing contributor get started.
I finally managed to get docky to compile after fiddling with dependencies for about 20 minutes. The final solution was to "apt-get build-dep gnome-do f-spot" (yes, that's probably overkill, but it worked).
What I would like to see is this:
1. a very short compilation guide, in the spirit of "install foo and bar, then run autogen.sh or open Docky-2.sln".
2. a simple overview of docky's architecture: what each project does and how it fits together with the rest.
3. a code style and best practices guide. (For example, the project is using Mono-style formatting as far as I can see, stuff like that).
4. a simple guide to writing a plugin (maybe even provide a skeletal plugin that the user can jump in and edit directly).
5. any other thing you think a new developer should be aware of (for example, licensing, copyright, how to submit a patch...)
Docky is developed on Mono which is a huge advantage and explains why it has managed to match and surpass other similar - but much older - projects. However, the lower you can get the entry bar, the more people will be willing to start contributing quick patches, features and plugins to the project.
Thanks!
Question information
- Language:
- English Edit question
- Status:
- Invalid
- For:
- Docky Edit question
- Assignee:
- No assignee Edit question
- Solved by:
- Robert Dyer
- Solved:
- Last query:
- Last reply: