search

pckg / database

Simple ORM for PDO, MySQL and Faker. Organize your code to records, entities, repositories, define data relations, handle changes with events and many more.
MIT License
2 stars 0 forks source link

Docs #3

Open schtr4jh opened 7 years ago

schtr4jh commented 7 years ago

First, I need to create docblocks and comment whole code so other developers will be able to understand it. Then I need to write some examples of how to build simple and advanced queries, define relations, use event dispatcher, use collections and transformations, use i18n, l17n and other extensions, and basically document every functionality. :)

felipextrindade commented 7 years ago

Can you provide more info on this?

schtr4jh commented 7 years ago

Hey @felipextrindade, thanks for participating (or at least trying to :)). pckg/database package is (along with order pckg packages) used on few projects, but because of the lack of the time I was not able to document changes during development (lame excuse, right, I promise I will change this in the future :)).

What I want to do is write docs for all pckg projects. I know this is long shot since code is currently not well documented and will take a lot of time to do it, but I have to begin somewhere, right. :)

Menelion commented 7 years ago

@schtr4jh, so maybe is it worth to split the huge docs issues so several people could contribute various parts of the docs independently? I would try, for example, but I'm not sure I will manage to do the whole thing during October :). Thanks!

schtr4jh commented 7 years ago

@Oire Hello and thanks to you too ;)

I've created table of contents for better overview. I will mark section as done when we write docblocks, comment all code and write documentation in wiki.

I will also prepare some guidelines for contribution and create wiki pages. Any english fluent speaker/writer would be appreciated for writing/editing documentation. :)