Skip to content

Commit b95194c

Browse files
vLuckyyyJakubk15
andauthored
GH-306 Refactor PR Template, Contributing file, delete auto assign (#306)
* Refactor PR Template, Contributing file, delete auto assign * Update .github/CONTRIBUTING.md Co-authored-by: Jakubk15 <[email protected]> * Update LICENSE Co-authored-by: Jakubk15 <[email protected]> Co-authored-by: Jakubk15 <[email protected]>
1 parent 821e387 commit b95194c

File tree

4 files changed

+55
-26
lines changed

4 files changed

+55
-26
lines changed

.github/CONTRIBUTING.md

+23-14
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,30 @@
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.
23

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).
410

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.
613

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.
816

9-
## Naming
17+
## Submitting a Pull Request
18+
When submitting a pull request, please make sure to follow these guidelines:
1019

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.
1226

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.
1429

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!

.github/PULL_REQUEST_TEMPLATE.md

+30-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,31 @@
1-
**Please describe the changes made by this PR and why they need to be merged:**
2-
---
3-
**NOTE:** Remember to add all the necessary changes to the CHANGELOGS file
1+
## Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
## How Has This Been Tested?
17+
18+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
19+
20+
- [ ] Test A
21+
- [ ] Test B
22+
23+
## Checklist:
24+
25+
- [ ] My code follows the style guidelines of this project
26+
- [ ] I have performed a self-review of my own code
27+
- [ ] I have made corresponding changes to readme etc.
28+
- [ ] My changes generate no new warnings
29+
- [ ] I have added test to cover my changes
30+
- [ ] I have added appropriate labels to this Pull Request
431

5-
**Status:**

.github/auto_assign.yml

-6
This file was deleted.

LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -632,7 +632,7 @@ state the exclusion of warranty; and each file should have at least
632632
the "copyright" line and a pointer to where the full notice is found.
633633

634634
<one line to give the program's name and a brief idea of what it does.>
635-
Copyright (C) <year> <name of author>
635+
Copyright (C) 2022-2023 EternalCode
636636

637637
This program is free software: you can redistribute it and/or modify
638638
it under the terms of the GNU General Public License as published by
@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
652652
If the program does terminal interaction, make it output a short
653653
notice like this when it starts in an interactive mode:
654654

655-
<program> Copyright (C) <year> <name of author>
655+
Copyright (C) 2022-2023 EternalCode
656656
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657657
This is free software, and you are welcome to redistribute it
658658
under certain conditions; type `show c' for details.

0 commit comments

Comments
 (0)