|
1 |
| -# We have a few simple rules while making a new PR. |
| 1 | +# Contributing to EternalCore |
| 2 | +We welcome contributions to EternalCore! Whether you're fixing a bug, adding a new feature, or improving documentation, we're glad to have your help. |
2 | 3 |
|
3 |
| -## Code style |
| 4 | +## How to Contribute |
| 5 | +1. Fork the repository. |
| 6 | +2. Create a new branch for your feature or bug fix. |
| 7 | +3. Make your changes, and test them thoroughly. |
| 8 | +4. Commit your changes and push them to your fork. |
| 9 | +5. Submit a pull request to the main repository in [PR tab](https://github.com/EternalCodeTeam/EternalCore/compare). |
4 | 10 |
|
5 |
| -#### Try to stick with our code style. Browse files, and you will know what we actually mean. Keep in mind that we don't use '*' imports. |
| 11 | +## Code of Conduct |
| 12 | +We ask that all contributors adhere to our [code of conduct](./CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms. |
6 | 13 |
|
7 |
| -#### Also don't include the `.idea/` folder. |
| 14 | +## Reporting Issues |
| 15 | +If you find an issue with the plugin, please report it in the [Issues tab](https://github.com/EternalCodeTeam/EternalCore/issues/new/choose). Please provide as much information as possible, including the version of server software that you are using and the plugin you are using, as well as any error messages or logs. |
8 | 16 |
|
9 |
| -## Naming |
| 17 | +## Submitting a Pull Request |
| 18 | +When submitting a pull request, please make sure to follow these guidelines: |
10 | 19 |
|
11 |
| -#### Pull requests should be named like that: |
| 20 | +* Make sure that your code adheres to the plugin's existing coding style. |
| 21 | +* Test your changes thoroughly before submitting the pull request. |
| 22 | +* If your pull request is related to an existing issue, please reference the issue in your pull request. |
| 23 | +* Provide a detailed description of your changes and their motivation. |
| 24 | +* Include any relevant screenshots or demonstrations of the changes. |
| 25 | +* Make sure that your pull request passes all automated tests and code checks. |
12 | 26 |
|
13 |
| -`GH-{NUMBER} Title of PR` |
| 27 | +## License |
| 28 | +EternalCore is licensed under the [GPL-3.0](../LICENSE). By contributing to this project, you agree to license your contributions under the same terms. |
14 | 29 |
|
15 |
| -Please don't include troll, racist and sexual names. We are a mature project. |
16 |
| - |
17 |
| -## Building |
18 |
| - |
19 |
| -#### You can build EternalCore using `shadowJar` Gradle task or `./gradlew shadowJar` Command in GitBash. |
20 |
| - |
21 |
| -#### Output file will be located at `build/libs` |
| 30 | +Thank you for your interest in contributing to EternalCore! |
0 commit comments