We would love to get input from all developers out there!
We develop new stuff utilizing the Gitflow Workflow with minor adjustments. The decision about it was discussed here, if you have questions go ahead and post them there!
- Fork Kimai or one of its other repos
- Clone repository to your local disc
- Checkout develop (
git checkout -b develop origin/develop) - Create a branch for your feature (
git checkout -b my_feature) - Commit the changes to your fork. In your commit message refer to the issue number if there is already one, e.g. (
git commit -am "fixed this and that (resolves #0815)") - Push your branch (
git push origin my_feature) - Submit a Pull Request using GitHub with a link to your branch (here are some hints on How to write the perfect pull request)
- git remote add upstream https://github.com/kimai/kimai.git
- git fetch upstream
- git checkout develop
- git merge upstream/develop
- git push origin develop
Here are a few rules to follow in order to ease code reviews and discussions before maintainers accept and merge your work:
- You SHOULD write documentation.
- Please, write commit messages that make sense, and rebase your branch before submitting your Pull Request.
- When creating your Pull Request, you MUST write a description which explains why you are creating it.
- Follow PSR-2 code style
- No whitespace changes in a Pull Request
- We know that a lot of the Kimai codebase is old. Feel free to improve it!
- You can restructure the code, but that should be done in an independent branch
- Make sure the Pull Request has a decent size, otherwise we won't be able to review and merge it