Contributing

Kohana is community driven, and we rely on community contributions for the documentation.

Guidelines

Documentation should use complete sentences, good grammar, and be as clear as possible. Use lots of example code, but make sure the examples follow the Kohana conventions and style.

Try to commit often, with each commit only changing a file or two, rather than changing a ton of files and commiting it all at once. This will make it easier to offer feedback and merge your changes. Make sure your commit messages are clear and descriptive. Bad: “Added docs”, Good: “Added initial draft of hello world tutorial”, Bad: “Fixed typos”, Good: “Fixed typos on the query builder page”

If you feel a menu needs to be rearranged or a module needs new pages, please open a bug report to discuss it.

Quick Method

To quickly point out something that needs improvement, report a bug report.

If you want to contribute some changes, you can do so right from your browser without even knowing git!

First create an account on GitHub.

You will need to fork the module for the area you want to improve. For example, to improve the ORM documentation fork http://github.com/kohana/orm. To improve the Kohana documentation, fork http://github.com/kohana/core, etc. So, find the module you want to improve and click on the Fork button in the top right.

The files that make the User Guide portion are found in guide/<module>/, and the API browser portion is made from the comments in the source code itself. Navigate to one of the files you want to change and click the edit button in the top right of the file viewer.

Make the changes and add a detailed commit message. Repeat this for as many files as you want to improve. (Note that you can’t preview what the changes will look unless you actually test it locally.)

After you have made your changes, send a pull request so your improvements can be reviewed to be merged into the official documentation.

Once your pull request has been accepted, you can delete your repository if you want. Your commit will have been copied to the official branch.

If you know Git

Short version

Fork the module whose docs you wish to improve (e.g. git://github.com/kohana/orm.git or git://github.com/kohana/core.git), checkout the 3.2/develop branch (for the 3.2 docs), make changes, and then send a pull request.

Long version

(This still assumes you at least know your way around Git, especially how submodules work.)

1. Fork the specific repo you want to contribute to on GitHub. (For example, go to http://github.com/kohana/core and click the fork button.)

2. Now you need to add your fork as a “git remote” to your application and ensure you are on the right branch. An example for the ORM module and 3.2 docs:

   cd my-kohana-app/modules/orm
   
   # add your repository as a new remote
   git remote add <your name> git://github.com/<your name>/orm.git
   
   # Get the correct branch
   git checkout 3.2/develop
   

3. Now go into the repo of the area of docs you want to contribute to and add your forked repo as a new remote, and push to it.

   cd my-kohana-app/modules/orm
   
   # Make some changes to the docs
   nano file.md
   
   # Commit your changes - Use a descriptive commit message! If there is a redmine ticket for the changes you are making include "Fixes #XXXXX" in the commit message so its tracked.
   git commit -a -m "Corrected a typo in the ORM docs. Fixes #12345."
   
   # make sure we are up to date with the latest changes
   git merge origin/3.2/develop
   
   # Now push your changes to your fork.
   git push <your name> 3.2/develop
   

4. Finally, send a pull request on GitHub.