diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..48f7937 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,100 @@ +name: Bug Report +description: Found a bug? Report it here! +title: "[BUG] " +labels: ["bug"] +assignees: + - Patricklumowa +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this template! + **The more information you provide, the easier it will be to identify and fix the bug.** + If you want a guide on filing bug reports effectively, you can [find it here](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html). + - type: checkboxes + id: checked-bugs + attributes: + label: Have you checked to see if this issue has already been reported? + options: + - label: This bug has not been previously reported. + validations: + required: true + - type: textarea + id: describe-bug + attributes: + label: Describe The Bug + description: "Explain what goes wrong when using the bot." + placeholder: "E.g. The bot places pixels on the wrong coordinates or skips areas." + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: "Describe what you expected to happen or why you think the current behavior is wrong." + placeholder: | + E.g. The bot should place pixels exactly according to the template image. + E.g. The bot should respect rate limits and avoid bans. + validations: + required: false + - type: textarea + id: things-tried + attributes: + label: Things You Tried + description: "List all attempts you made to fix or work around the bug." + placeholder: "E.g. Restarted the bot, tried a different template, or updated the pixel map." + validations: + required: false + - type: textarea + id: reproduce-bug + attributes: + label: Reproduce The Bug + description: "Explain exactly how to trigger the bug." + placeholder: | + E.g. + 1. Launch the bot + 2. Load a template image + 3. Start pixel placement + 4. Observe that some pixels are placed incorrectly or skipped + validations: + required: false + - type: textarea + id: error-message + attributes: + label: Error Message + description: "If there are error messages, add them here." + placeholder: "E.g. Error: Coordinates out of range!" + validations: + required: false + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: "Include screenshots or links to illustrate the problem." + placeholder: "E.g. Imgur link showing the pixel placement error" + validations: + required: false + - type: textarea + id: system-information + attributes: + label: System Information + description: "Provide details about your OS, bot version, and browser. Please fill this out!" + placeholder: | + OS: (E.g. Windows) + wplace-autoBOT Version: 2.0 + Browser: Mozilla 142.0 + You found an easter egg :3 + value: | + OS: + wplace-autoBOT Version: + Browser: + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional Information + description: "Add any other context about the problem here." + placeholder: "E.g. This issue started after the last update or happens only with large templates." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..c92e633 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Community Support & Questions (Discord) + url: https://discord.gg/knkNRYyQcm + about: Join the Discord if you have questions or want to discuss AutoBOT with the community. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..8d442eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,48 @@ +name: Feature Request +description: Have an idea you want added? Suggest it here! +title: "[FEAT] " +labels: ["enhancement"] +assignees: + - Patricklumowa +body: + - type: textarea + id: related-problem + attributes: + label: Is your feature request related to a problem? Please describe. + description: "Describe what the problem is." + placeholder: | + E.g. It's tedious to manually place pixels to recreate complex designs. + E.g. The bot currently can't detect areas that need fixing automatically. + validations: + required: false + - type: textarea + id: feature-solution + attributes: + label: Describe the solution you'd like + description: "Describe what you want to happen." + placeholder: | + E.g. Add an automatic pixel placement feature that matches a template image. + E.g. Implement prioritization of important areas first, like outlines or text. + E.g. Allow configuration of rate limits to avoid getting banned. + validations: + required: true + - type: textarea + id: feature-alternatives + attributes: + label: Describe alternatives you've considered + description: "Describe any alternative solutions or features you've considered." + placeholder: | + E.g. Manually placing pixels myself. + E.g. Using a different bot that doesn't support template images. + E.g. Semi-automatic scripts that still require manual correction. + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. If your feature is based on "something," please add any links relative to that "something" here. + placeholder: | + E.g. A sample template image the bot should replicate. + E.g. A video of the bot in action or a similar tool online. + E.g. Notes on color palette, priority zones, or timing restrictions. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..5b2ef76 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,28 @@ +# Pull Request +Fill out the following details to submit your PR. + +## Summary +Please briefly describe the changes in your PR. +E.g. Fixes display bug with templates. +E.g. Adds a template tab that users can manage all templates through. + +## Related Issue(s) +Link to the related issues your PR would solve here. +E.g. Fixes #14 +E.g. Adds #4 + +## Changes +Select the type of change your PR is: +- [ ] Feature +- [ ] Bug fix +- [ ] Documentation +- [ ] Refactoring +- [ ] Build +- [ ] Other + +## Checklist +- [ ] This PR follows the project's style of coding and documentation. +- [ ] Auto-Bot has been verified to work correctly for this PR. + +## Additional Notes +Anything else reviewers should know? \ No newline at end of file