Contributing

Introduction

The Hours time tracker is open source software, written by contributors from around the world. We are always looking for new contributors.

The hours CLI is written in the PHP programming language with the Laravel Zero framework. To contribute code you will need a basic understanding of PHP and Git.

Setup

To install Hours for development you will need php, git, sqlite, and composer.

First fork the repository on Github.

You will see a link to ‘Clone or download’ your fork. Either open the link with Github Desktop or copy the URL into your terminal and clone the repo with git:

git clone git@github.com:<your-username>/hours.git

Next change to the application directory and install composer dependencies:

cd hours
composer install

Finally confirm the application works:

php hours list

Writing Code

The internals documentation explains how everything works and what you need to know to get started writing code.

Writing Docs

We are always looking for contributors that would like to improve the documentation. The documentation README covers everything you need to know about contributing to the docs.

Project Management

All project management happens through our Github Repo. Collaboration happens through projects, issues, and pull requests.

If you are looking to get started have a look at our starter issues.

Pull Requests

Make sure to read our contributor guidelines before creating a pull request. The contributor guidelines cover everything you need to know about contributing code changes.

If something doesn’t make sense don’t worry — just open a pull request and we can walk you through it.

Feel free to open a pull request even if it’s not ready to merge! Opening a pull request early makes it easy to collaborate — you can ask questions, get feedback, and let others know that you have started working on it. Github makes this easy with draft pull requests.

Releases

The release process is documented for maintainers.