mirror of
https://github.com/CachetHQ/Cachet.git
synced 2025-02-13 12:32:08 +01:00
83 lines
2.8 KiB
Markdown
83 lines
2.8 KiB
Markdown
# Contribution Guidelines
|
||
|
||
## Creating issues
|
||
|
||
Issues should be made by using the [issue tracker](https://github.com/cachethq/Cachet/issues).
|
||
|
||
Things to remember:
|
||
|
||
- Be descriptive
|
||
- Be respectful of others
|
||
|
||
## Languages
|
||
|
||
When needing to add labels, placeholders or general text, you **must not** write directly into the source file, rather make use of the `./app/lang/` directory. Always provide the English translation and copy your English string to all other languages - making sure that the indentation and alignment of the arrays are updated.
|
||
|
||
## Coding Standards
|
||
|
||
Please follow existing coding standards:
|
||
|
||
```php
|
||
<?php
|
||
|
||
namespace Foo\Bar\Controller;
|
||
|
||
use Foo\Bar\Bar;
|
||
|
||
class Foo extends Bar
|
||
{
|
||
public function baz()
|
||
{
|
||
if ($condition) {
|
||
}
|
||
}
|
||
}
|
||
|
||
```
|
||
|
||
- At least one newline separating `namespace`, `use`, `function` and `class` declarations.
|
||
- Spaces around operators, loops, conditions and control blocks:
|
||
```php
|
||
<?php
|
||
use \Exception;
|
||
|
||
if ($condition === (10 + 2)) {
|
||
try {
|
||
throw Exception("Something went wrong...");
|
||
} catch (Exception $e) {
|
||
// Do something here.
|
||
}
|
||
}
|
||
```
|
||
- Braces on a new line following: `namespace`, `use`, `function` and `class`.
|
||
- Line lengths have a soft 80 limit and hard 120 length.
|
||
- PHP constants should be in lowercase; `true`, `false` and `null`.
|
||
- Defined constants should always be in uppercase.
|
||
- Never leave trailing spaces at the end of a line.
|
||
- Files should end with one blank line.
|
||
- Do not use `# Bash` style comments.
|
||
- Always add or update Docblocs to functions.
|
||
- If your pull request consists of more than two commits, you **must** squash them into one.
|
||
|
||
If you're still unsure, then take a look at existing code.
|
||
|
||
## Introduction into to Git and GitHub
|
||
|
||
If you are new to Git, GitHub and the whole open source software community, welcome! Here are some resources for getting started and understanding what it's all about.
|
||
|
||
- [Try Git](https://try.github.io/levels/1/challenges/1) by Code School
|
||
- [GitHub Help](https://help.github.com)
|
||
|
||
If you're not particularly fond of the command line, you can get one of GitHub's free GUI desktop apps:
|
||
|
||
- [GitHub for Mac](https://github.com/blog/1510-installing-git-from-github-for-mac)
|
||
- [GitHub for Windows](https://github.com/blog/1127-github-for-windows)
|
||
|
||
If you're feeling adventurous, you can become a Git & GitHub master with the [Git Path on Code School](https://www.codeschool.com/paths/git).
|
||
|
||
There is always the Cachet Gitter chat to ask any questions you may have:
|
||
|
||
[](https://gitter.im/cachethq/Cachet?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||
|
||
You should also make use of the [.editorconfig](/.editorconfig) file found within the root of the repository. It'll make sure that your editor is setup with the same file settings.
|