Skip to content

Commit

Permalink
Code style to PSR-12, updated README/contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
jarne committed Jul 25, 2021
1 parent c2e1bbe commit f461e61
Show file tree
Hide file tree
Showing 23 changed files with 921 additions and 741 deletions.
30 changes: 5 additions & 25 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,15 @@
Thanks for contributing to our project πŸŽ‰πŸ‘!

## πŸ˜‰ Code of Conduct
Everyone parcipating in this project must accept our [Code of Conduct](CODE_OF_CONDUCT.md) which rules the friendly together of all contributors.
Every developer participating in this project must accept our [Code of Conduct](CODE_OF_CONDUCT.md) which rules the friendly together of all contributors.

## ❔ Questions
Please ask questions on [Gitter](https://gitter.im/survanetwork/Worlds). You will get a faster answer there and don't disturb maintainers and contributors in the issue tracker.
Please ask questions on [Discord](https://discord.gg/t4Kg4j3829). You will get a faster answer there and don't disturb maintainers and contributors in the issue tracker.

## βœ‰οΈ Issues and Pull Requests
If you found a bug or have an idea how to improve or add a new feature, you're welcome to [open an issue](https://github.com/survanetwork/Worlds/issues/new). Please keep in mind this guidelines and [check if there is already an issue](https://github.com/survanetwork/Worlds/issues) with the same content like yours.
If you found a bug or have an idea how to improve or add a new feature, you're welcome to [open an issue](https://github.com/survanetwork/Worlds/issues/new). Please keep those guidelines in mind and [check if there is already an issue](https://github.com/survanetwork/Worlds/issues) with the same content.

Feel free to [open a pull request](https://github.com/survanetwork/Worlds/compare) if you fixed a bug or added or improved a feature.
Feel free to [open a pull request](https://github.com/survanetwork/Worlds/compare) if you fixed a bug, added or improved a feature.

## 🎨 Code Style
This project is using a custom code style. Please see existing code files for more information.

Summary of the most important guidelines:

- Files must always end with an empty line

- Brackets are always written in the same line and with a space
```
function testThis() {
return "hello!";
}
```

- There must be no space in front of commands like if and while
```
while(i < 5) {
if(e === 3) {
return true;
}
}
```
This project is using the [PSR-12 code style](https://www.php-fig.org/psr/psr-12/).
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
<a href="https://github.com/survanetwork/Worlds/blob/master/LICENSE">
<img src="https://img.shields.io/badge/license-CC--BY--NC--SA--4.0-orange.svg" alt="License">
</a>
<a href="https://gitter.im/survanetwork/Worlds">
<img src="https://img.shields.io/gitter/room/survanetwork/Worlds.svg" alt="Gitter">
<a href="https://discord.gg/t4Kg4j3829">
<img src="https://img.shields.io/discord/685532530451283997?color=blueviolet" alt="Discord">
</a>
<a href="https://twitter.com/survanetwork">
<img src="https://img.shields.io/twitter/url?label=SURVA%20network%20on%20Twitter&style=social&url=https%3A%2F%2Ftwitter.com%2Fsurvanetwork" alt="Twitter">
Expand Down Expand Up @@ -94,7 +94,9 @@ Worlds is really easy to use. Here is the command syntax:
/worlds defaults unset <permission|gamemode|build|pvp|damage|interact|explode|drop|hunger|fly|daylightcycle>
```

For a full list of commands, their usage and a description what they are for, take a look at the [wiki](https://github.com/survanetwork/Worlds/wiki/Commands).
For a full list of commands, their usage and a description what they are for, take a look at the [wiki](https://plugins.surva.net/docs/Worlds#commands).

[Read the full documentation πŸ“–](https://plugins.surva.net/docs/Worlds) β€’ [Ask questions on Discord πŸ’¬](https://discord.gg/t4Kg4j3829)

## πŸ™‹β€ Contribution
Feel free to contribute if you have ideas or found an issue.
Expand Down
Loading

0 comments on commit f461e61

Please sign in to comment.