Skip to content

make it easier for developers to contribute #384

Open
@aspiers

Description

@aspiers

Please forgive me spamming the project with new issues :-) But I'm excited to discover this tool and want to help it make better, and since I have very limited time, more importantly help others make it better.

Currently the user documentation is really great! However the developer documentation seems non-existent. The code looks nice, but there seems to be very little explanation of how everything fits together, which makes it hard for newbie developers to contribute.

So I suggest some simple steps in descending order of priority:

  • Build a list of all the source code files which describes briefly what each one does.
  • Write a short architecture document which describes how the different files / data structures combine together.
  • Start documenting individual data structures.
--- Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/39674771-make-it-easier-for-developers-to-contribute?utm_campaign=plugin&utm_content=tracker%2F449456&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F449456&utm_medium=issues&utm_source=github).

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions