Skip to content

Commit

Permalink
Update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
nmtho committed Nov 29, 2023
1 parent e8c515f commit d2811a6
Showing 1 changed file with 47 additions and 49 deletions.
96 changes: 47 additions & 49 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,47 @@
# Contributing to Oh My PMMP

Welcome, and thank you for your interest in contributing to Oh My PMMP!

# Reporting Issues

Have a problem with Oh My PMMP or a feature request? We want to hear about it!

**NOTE:** Please check if the issue exists before creating.

If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.

# Writing good bug reports and feature requests

To have a good bug reports and feature requests, please follow these guidelines:
- Only a single issue per issue and feature request.
- The more information you provide, the more likely it is that someone or us will succeed in recreating the problem and finding a fix.

Please include the following with each issue:
- Version of PocketMine.
- Version of PHP.
- Your OS.
- What you expected to see, versus what you actually saw.
- Steps to reproduce the issue.
- Images, logs, or a link to a video showing the issue occurring.

# Translate this plugin

Before translate this plugin, please add the language will be translated to the `availableLanguages` array in [`resources/config.yml`](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/resources/config.yml#L1)
Copy the `resources/lang/eng.ini`, rename and translate it.
**NOTE:** The language name in `availableLanguages` must be the same as the language file name in `resources/lang/`.

For example:
```yaml
availableLanguages: [eng] # => availableLanguages: [eng, vie, rus, ukr]
```
And the `resources/lang` folder will have:
- eng.ini
- vie.ini
- rus.ini
- ukr.ini

# Asking Questions

Please join our [Discord server](https://discord.gg/cEXW8uK6QA) to ask questions, get help, and discuss the project.

# Thank You!

Thank you for taking the time to contribute.
# Contributing to Oh My PMMP

Welcome, and thank you for your interest in contributing to Oh My PMMP!

# Reporting Issues

Have a problem with Oh My PMMP or a feature request? We want to hear about it!

**NOTE:** Please check if the issue exists before creating.

If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.

# Writing good bug reports and feature requests

To have a good bug reports and feature requests, please follow these guidelines:
- Only a single issue per issue and feature request.
- The more information you provide, the more likely it is that someone or us will succeed in recreating the problem and finding a fix.

Please include the following with each issue:
- Version of PocketMine.
- Version of PHP.
- Your OS.
- What you expected to see, versus what you actually saw.
- Steps to reproduce the issue.
- Images, logs, or a link to a video showing the issue occurring.

# Translate this plugin

Before translate this plugin, please add the language will be translated to the `AVAILABLE_LANGUAGES` array in [`src/Vars.php`](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/src/Vars.php#L18)
Copy the `resources/lang/en_US.json`, rename and translate it.
**NOTE:** The language name in `AVAILABLE_LANGUAGES` must be the same as the language file name in `resources/lang/`.

For example:
```php
public const AVAILABLE_LANGUAGES = ["en_US"]; # => public const AVAILABLE_LANGUAGES = ["en_US", "vi_VN"];
```
And the `resources/lang` folder will have:
- en_US.json
- vi_VN.json

# Asking Questions

Please join our [Discord server](https://discord.gg/PykBfE2TZ9) to ask questions, get help, and discuss the project.

# Thank You!

Thank you for taking the time to contribute.

0 comments on commit d2811a6

Please sign in to comment.