jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

various documentation updates (#176)

Browse Source 
* updated README
* improved CONTRIBUTING guidelines
* improved wording on developer docu
This commit is contained in:
Kevin Papst
2018-06-23 21:20:20 +02:00
committed by GitHub
parent e9e61afc76
commit c3251ee435
4 changed files with 62 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
CONTRIBUTING.md
View File

@@ -1,16 +1,17 @@
# Contributing
The Kimai application is an open source project. Contributions made by the community are welcome.
Kimai is an open source project, contributions made by the community are welcome.
Send us your ideas, code reviews, pull requests and feature requests to help us improve this project.
## Pull request rules
- We use PSR-2 with some addons code styles (check our [php-cs-fixer config](.php_cs.dist)), run `bin/console kimai:phpcs` to verify and `bin/console kimai:phpcs --fix` to fix violations
- Add PHPUnit tests for your changes, verify everything still works and execute our test-suites `bin/console kimai:test-unit` and `bin/console kimai:test-integration`
- If you contribute new files, please add them with the file-header template from below
- With sending in a PR, you accept that your contributions/code will be published under MIT license (see the LICENSE file as well)
- If one of the checks fail, please fix them before asking for a review
- We use PSR-2 with some additional code-style checks (see our [php-cs-fixer config](.php_cs.dist)). You can run `bin/console kimai:phpcs` to check and `bin/console kimai:phpcs --fix` to fix violations.
- Add PHPUnit tests for your changes, verify everything still works and execute our test-suites `bin/console kimai:test-unit` and `bin/console kimai:test-integration`.
- If you contribute new files, please add them with the file-header template from below (our chode-style fixer can do that for you).
- With sending in a PR, you accept that your contributions/code will be published under MIT license (see the [LICENSE](LICENSE) file as well).
- If one of the PR checks fails, please fix them before asking us for a review.
Further documentation can be found in the [developer documentation](var/docs/developers.md).
### File-header template
```
@@ -22,26 +23,3 @@ Send us your ideas, code reviews, pull requests and feature requests to help us
*/
```
## Translations
We try to keep the number of language files small to make it easier to identify the location for your new messages.
- If you add a new key, you have to add it in every language file
- Its very likely that you want to edit the file `messages` as it holds 90% of our application translations
The files in a quick overview:
- `AvanzuAdminTheme` is only meant for translating strings from the original theme
- `exceptions` only holds translations of error pages and exception handlers
- `flashmessages`
- `messages` holds most of the visible application translations
- `pagerfanta` includes the translations for the pagination component
- `sidebar` holds all the translations of the right sidebar
- `validators` only hold translations related to violations/validation of submitted form data (or API calls)
## Documentation
The documentation is in [var/docs/](var/docs/) and its available both at GitHub and in your running Kimai instance.
- Please verify that all links work in your Kimai instance before submitting