-
-
Notifications
You must be signed in to change notification settings - Fork 9
Migrate issue templates to GitHub Forms and add enhanced contribution documentation. #313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+217
−78
Merged
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
d6d575c
Migrate issue templates to GitHub Forms and add enhanced contribution…
vLuckyyy b7d6dbb
Update .github/CONTRIBUTING.md
vLuckyyy 4151936
Update .github/CONTRIBUTING.md
vLuckyyy 0934eae
Update pull request template to use `GH-{NUMBER}` in title format.
vLuckyyy fcac2d4
Update .github/CONTRIBUTING.md
Jakubk15 62f5706
Apply suggestions from code review
Jakubk15 1b6de7d
Apply suggestions from code review
Jakubk15 8467272
Update label for additional context field
Jakubk15 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,64 @@ | ||
| # Contributing to EternalCombat | ||
| # 👋 Contributing to EternalCombat | ||
|
|
||
| We welcome all contributions to the EternalCombat project! | ||
| First off, thanks for taking the time to contribute! 🎉 | ||
| We love user contributions and want to make it as easy as possible for you to get involved. | ||
|
|
||
| ### How to Contribute | ||
| ## 🛠️ Development Setup | ||
|
|
||
| 1. Fork the repository. | ||
| 2. Create a new branch for your feature or bug fix. | ||
| 3. Make your changes, and test them thoroughly. | ||
| 4. Commit your changes and push them to your fork. | ||
| 5. Submit a pull request to the main repository. | ||
| To start contributing, you'll need to set up your environment: | ||
|
|
||
| ### Code of Conduct | ||
| 1. **Java 21**: We use Java 21 for development. Ensure you have a JDK 21 installed. | ||
| 2. **IDE**: We recommend [IntelliJ IDEA](https://www.jetbrains.com/idea/) (Community or Ultimate). | ||
| 3. **Git**: Ensure you have Git installed. | ||
|
|
||
| We expect all contributors to follow our [code of conduct](CODE_OF_CONDUCT.md). | ||
| ### 📥 Getting the Code | ||
|
|
||
| ### Reporting Issues | ||
| ```bash | ||
| # Fork the repository first! | ||
Jakubk15 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| git clone https://github.com/YOUR-USERNAME/EternalCombat.git | ||
| cd EternalCombat | ||
| ``` | ||
|
|
||
| If you find an issue with the plugin, please report it in | ||
| the [Issues tab](https://github.com/EternalCodeTeam/EternalCombat/issues). Please provide as much information as | ||
| possible, including the version of Minecraft and the plugin you are using, as well as any error messagesSettings or logs. | ||
| ### 🔨 Building the Project | ||
|
|
||
| ### Compatibility | ||
| We use Gradle for building the project: | ||
Jakubk15 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| CombatLog has been tested on versions 1.17.1 - 1.19.3, but probably works on most versions of Minecraft. If you find | ||
| compatibility issues, please report them in the Issues tab. CombatLog uses java 11+, so you need to have it installed on | ||
| your server. | ||
| ```bash | ||
| # Build the project | ||
Jakubk15 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ./gradlew build | ||
| ``` | ||
|
|
||
| ### Submitting a Pull Request | ||
| ## 🤝 How to Contribute | ||
|
|
||
| When submitting a pull request, please make sure to follow these guidelines: | ||
| 1. **Fork & Clone**: Fork the repo to your own account and clone it. | ||
| 2. **Branch**: Create a new branch for your feature or fix. | ||
| ```bash | ||
| git checkout -b feat/my-awesome-feature | ||
| ``` | ||
| 3. **Code**: Hack away! 💻 | ||
| 4. **Test**: Run manual test by `runServer` to ensure you haven't broken anything. | ||
| ```bash | ||
| ./gradlew runServer | ||
| ``` | ||
| 5. **Push**: Push your changes to your fork. | ||
| 6. **Pull Request**: Open a PR against the `master` branch. | ||
|
|
||
| - Make sure that your code adheres to the plugin's existing coding style. | ||
| - Test your changes thoroughly before submitting the pull request. | ||
| - If your pull request is related to an existing issue, please reference the issue in your pull request. | ||
| - Thank you for your contributions to the EternalCombat project! | ||
| ## 📏 Code Style | ||
|
|
||
| Make sure that your code adheres to the plugin's existing coding style. | ||
|
|
||
| ## 🐛 Reporting Bugs | ||
|
|
||
| If you find a bug, please use the **Bug Report** issue template. | ||
| - Check if the issue already exists. | ||
| - Provide a minimal reproduction if possible. | ||
| - Include logs and screenshots. | ||
|
|
||
| ## 💡 Feature Requests | ||
|
|
||
| Have an idea? Use the **Feature Request** issue template. | ||
| - Explain *why* this feature is useful. | ||
| - Describe how it should look or behave. | ||
|
|
||
| ## 📄 License | ||
| By contributing, you agree that your contributions will be licensed under the project's [License](../LICENSE). | ||
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| name: 🐛 Bug Report | ||
| description: File a bug report to help us improve EternalCombat | ||
| title: "[Bug]: " | ||
| labels: ["bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! | ||
| Please ensure that you have searched the existing issues to see if this bug has already been reported. | ||
|
|
||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Bug Description | ||
Jakubk15 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| description: A clear and concise description of what the bug is. | ||
| placeholder: I was doing X and Y happened... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: reproduction | ||
| attributes: | ||
| label: Steps to Reproduce | ||
Jakubk15 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| description: Please provide a step-by-step guide to reproduce the issue. | ||
| placeholder: | | ||
| 1. Go to '...' | ||
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. See error | ||
Jakubk15 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected Behavior | ||
Jakubk15 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| description: A clear and concise description of what you expected to happen. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: screenshots | ||
| attributes: | ||
| label: Screenshots/Video | ||
| description: If applicable, add screenshots or a video to help explain your problem. | ||
|
|
||
| - type: dropdown | ||
| id: server-software | ||
| attributes: | ||
| label: Server Software | ||
| description: What server software are you using? | ||
| options: | ||
| - Paper | ||
| - Purpur | ||
| - Spigot | ||
| - Folia | ||
| - Other (please specify in logs) | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: minecraft-version | ||
| attributes: | ||
| label: Minecraft Version | ||
| description: What version of Minecraft are you running? (e.g. 1.20.4) | ||
| placeholder: 1.20.4 | ||
Jakubk15 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: plugin-version | ||
| attributes: | ||
| label: Plugin Version | ||
| description: What version of EternalCombat are you running? (Check with /eternalcombat version) | ||
| placeholder: v1.0.0 | ||
Jakubk15 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Logs / Stack Trace | ||
| description: Please paste any relevant logs or stack traces here. Use a pastebin service if the log is too long. | ||
| render: shell | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: 💬 Discord Community | ||
| url: https://discord.com/invite/FQ7jmGBd6c | ||
| about: Please ask questions and discuss ideas in our Discord server before opening a generic issue. | ||
| - name: 📖 Documentation | ||
| url: https://eternalcode.pl/docs/eternalcombat/introduction | ||
| about: Read the documentation to see if your question is already answered. |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| name: 💡 Feature Request | ||
| description: Suggest an idea for EternalCombat | ||
| title: "[Feature]: " | ||
| labels: ["feature"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for suggesting a new feature! Please explain your idea in detail. | ||
|
|
||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: Is your feature request related to a problem? | ||
| description: Please describe the problem you are trying to solve. | ||
| placeholder: I'm always frustrated when... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: solution | ||
| attributes: | ||
| label: Describe the solution you'd like | ||
| description: A clear and concise description of what you want to happen. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Describe alternatives you've considered | ||
| description: A clear and concise description of any alternative solutions or features you've considered. | ||
|
|
||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: Additional Context | ||
| description: Add any other context or screenshots about the feature request here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,35 @@ | ||
| **Please describe the changes made by this PR and why they need to be merged:** | ||
| --- | ||
| name: Pull Request | ||
| about: Submit a contribution to EternalCombat | ||
| title: 'GH-{NUMBER} <title>' | ||
| labels: [] | ||
| assignees: [] | ||
| --- | ||
|
|
||
| ## 📝 Description | ||
| <!-- | ||
| Please submit your PR using the following title format: | ||
| feat: Description of the new feature | ||
| fix: Description of the bug fix | ||
| chore: Maintenance tasks | ||
| docs: Documentation changes | ||
| --> | ||
|
|
||
| <!-- Describe your changes clearly and concisely. Why is this change needed? What does it accomplish? --> | ||
|
|
||
| ## 🎯 Type of Change | ||
| <!-- Please check the boxes that apply to your changes --> | ||
| - [ ] 🐛 Bug fix (non-breaking change which fixes an issue) | ||
| - [ ] ✨ New feature (non-breaking change which adds functionality) | ||
| - [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
| - [ ] 🔧 Refactoring (no functional changes, just code improvements) | ||
| - [ ] 🎨 Style/Cosmetic (formatting, whitespace, visual changes) | ||
| - [ ] 📚 Documentation (updates to documentation or README) | ||
| - [ ] 🤖 CI/CD/Build (changes to workflows, gradle, etc.) | ||
|
|
||
| **Test Environment:** | ||
| - **Minecraft Version:** <!-- e.g. 1.20.4 --> | ||
| - **Java Version:** <!-- e.g. 21 --> | ||
| - **Platform:** <!-- e.g. Windows/Linux/MacOS --> | ||
|
|
||
| ## 📸 Screenshots (if applicable) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.