From c3acc0c0aafa68ad811cdb6973701ef2ff708bc6 Mon Sep 17 00:00:00 2001 From: ultimateownsz Date: Fri, 14 Feb 2025 14:50:24 +0100 Subject: [PATCH 1/4] deleted old files --- .github/ISSUE_TEMPLATE/contributor_guide.md | 84 ------------------- .../user_story_issue_template.md | 72 ---------------- 2 files changed, 156 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/contributor_guide.md delete mode 100644 .github/ISSUE_TEMPLATE/user_story_issue_template.md diff --git a/.github/ISSUE_TEMPLATE/contributor_guide.md b/.github/ISSUE_TEMPLATE/contributor_guide.md deleted file mode 100644 index 8cccf17..0000000 --- a/.github/ISSUE_TEMPLATE/contributor_guide.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -name: Contributor Guide -about: Helping contributors propose or document what they are working on -title: IDEA -labels: enhancement, discussion, help wanted -assignees: '' - ---- - -# Welcome to the Project! - -Thank you for your interest in contributing to PySeas! This guide will help you propose or document your contribution and understand how to get started. - -## Proposal or Task Description - -**What should you do here?** -- Briefly describe what you want to work on. -- Explain the feature, bug fix, or improvement you’d like to address. - -**Example:** -> I noticed that the player movement in the game feels a bit laggy. I’d like to optimize the movement by adjusting the way we calculate position updates. - ---- - -## Why is this Needed? - -**What should you do here?** -- Explain why this task is important. -- What problem does it solve? How will it improve the project? - -**Example:** -> Optimizing the player movement will make the game feel more responsive, which improves the overall user experience. - ---- - -## How to Work on This Task - -**What should you do here?** -- If you’re proposing an idea, add steps for how you think it could be implemented. -- If you’re working on an assigned task, describe your approach. - -
-Click to expand for examples - -### Example: Improving Player Movement - -1. Investigate the current movement system in `/player_movement.py`. -2. Research techniques for smoother position updates (e.g., interpolation). -3. Write a test to measure performance before and after the change. -4. Optimize the code and test again. - -
- ---- - -## Questions or Feedback Needed - -**What should you do here?** -- List any questions or concerns you have. -- Ask for specific feedback from maintainers if needed. - -**Example:** -> I’m not sure if we should optimize movement directly in `/player_movement.py` or abstract it into a new class. What’s your suggestion? - -## Resources or Context - -**What should you do here?** -- Share links, code snippets, or other information that will help others understand your idea. -- Provide paths to related files or documentation. - -**Example:** -- Code snippet: `/player_movement.py` line 45. -- Related issue: [Issue #123](https://github.com/ultimateownsz/PySeas/issues). - ---- - -# Next Steps - -Once you’ve submitted this issue: -1. A maintainer will review your proposal and provide feedback. -2. You’ll be assigned to work on the task (if approved). -3. Follow the steps you outlined to complete the task. - -Thank you for contributing to the project! 😊 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/user_story_issue_template.md b/.github/ISSUE_TEMPLATE/user_story_issue_template.md deleted file mode 100644 index ee9c790..0000000 --- a/.github/ISSUE_TEMPLATE/user_story_issue_template.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -name: User Story-Based Issue -about: Break down complex features into multiple user stories for easier collaboration -title: '' -labels: enhancement, discussion -assignees: '' - ---- - - -# User Story -_As a [user role]**, I want **[specific goal or feature]** so that **[benefit or reason]_. - -**Description (optional):** -Provide additional context or background for this user story. - ---- - - - -## Acceptance Criteria - -These are the conditions that must be met for this user story to be considered complete: -- [ ] [Criterion 1] -- [ ] [Criterion 2] -- [ ] [Criterion 3] - ---- - -## Tasks -Each task represents an actionable step. Tasks can be converted into separate issues if needed. - -### Actionable Tasks - -- [ ] **Task 1: [Brief description]** - - **Details**: - - **Files/Modules Affected**: - - **Related Resources**: -- [ ] **Task 2: [Brief description]** - - **Details**: [Optional: Additional context or requirements for this task.] - - **Files/Modules Affected**: - - **Related Resources**: -- [ ] **Task 3: [Brief description]** - - **Details**: - - **Files/Modules Affected**: - - **Related Resources**: - ---- - -## Notes for Contributors -- Tasks can be converted into individual issues if needed. -- Feel free to suggest addional tasks or improvements. - - - ---- - -# Additional Information (optional) -[Include any screenshots, designs, or other supporting information here.] From a49bac4c0b38ecfff97c306a0a03f97d8329cc25 Mon Sep 17 00:00:00 2001 From: ultimateownsz Date: Fri, 14 Feb 2025 14:51:19 +0100 Subject: [PATCH 2/4] moved templates to correct dir this adds the two issue templates to the issue template dir --- .../ISSUE_TEMPLATE/contributor_guide.md | 84 +++++++++++++++++++ .../ISSUE_TEMPLATE/user_story_based_issue.md | 72 ++++++++++++++++ 2 files changed, 156 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/contributor_guide.md create mode 100644 .github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/user_story_based_issue.md diff --git a/.github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/contributor_guide.md b/.github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/contributor_guide.md new file mode 100644 index 0000000..12c894c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/contributor_guide.md @@ -0,0 +1,84 @@ +--- +name: Contributor Guide +about: Helping contributors propose or document what they are working on +title: IDEA +labels: enhancement, discussion, help wanted +assignees: '' + +--- + +# Welcome to the Project! + +Thank you for your interest in contributing to PyCeas! This guide will help you propose or document your contribution and understand how to get started. + +## Proposal or Task Description + +**What should you do here?** +- Briefly describe what you want to work on. +- Explain the feature, bug fix, or improvement you’d like to address. + +**Example:** +> I noticed that the player movement in the game feels a bit laggy. I’d like to optimize the movement by adjusting the way we calculate position updates. + +--- + +## Why is this Needed? + +**What should you do here?** +- Explain why this task is important. +- What problem does it solve? How will it improve the project? + +**Example:** +> Optimizing the player movement will make the game feel more responsive, which improves the overall user experience. + +--- + +## How to Work on This Task + +**What should you do here?** +- If you’re proposing an idea, add steps for how you think it could be implemented. +- If you’re working on an assigned task, describe your approach. + +
+Click to expand for examples + +### Example: Improving Player Movement + +1. Investigate the current movement system in `/player_movement.py`. +2. Research techniques for smoother position updates (e.g., interpolation). +3. Write a test to measure performance before and after the change. +4. Optimize the code and test again. + +
+ +--- + +## Questions or Feedback Needed + +**What should you do here?** +- List any questions or concerns you have. +- Ask for specific feedback from maintainers if needed. + +**Example:** +> I’m not sure if we should optimize movement directly in `/player_movement.py` or abstract it into a new class. What’s your suggestion? + +## Resources or Context + +**What should you do here?** +- Share links, code snippets, or other information that will help others understand your idea. +- Provide paths to related files or documentation. + +**Example:** +- Code snippet: `/player_movement.py` line 45. +- Related issue: [Issue #123](https://github.com/example/repo/issues/123). + +--- + +# Next Steps + +Once you’ve submitted this issue: +1. A maintainer will review your proposal and provide feedback. +2. You’ll be assigned to work on the task (if approved). +3. Follow the steps you outlined to complete the task. + +Thank you for contributing to the project! 😊 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/user_story_based_issue.md b/.github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/user_story_based_issue.md new file mode 100644 index 0000000..b829773 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/user_story_based_issue.md @@ -0,0 +1,72 @@ +--- +name: User Story-Based Issue +about: Break down complex features into multiple user stories for easier collaboration +title: '' +labels: enhancement, discussion +assignees: '' + +--- + + +# User Story +_As a [user role]**, I want **[specific goal or feature]** so that **[benefit or reason]_. + +**Description (optional):** +Provide additional context or background for this user story. + +--- + + + +## Acceptance Criteria + +These are the conditions that must be met for this user story to be considered complete: +- [ ] Criterion 1 +- [ ] Criterion 2 +- [ ] Criterion 3 + +--- + +## Tasks +Each task represents an actionable step. Tasks can be converted into separate issues if needed. + +### Actionable Tasks + +- [ ] Task 1: Brief description + - **Details**: + - **Files/Modules Affected**: + - **Related Resources**: +- [ ] Task 2: Brief description + - **Details**: [Optional: Additional context or requirements for this task.] + - **Files/Modules Affected**: + - **Related Resources**: +- [ ] Task 3: Brief description + - **Details**: + - **Files/Modules Affected**: + - **Related Resources**: + +--- + +## Notes for Contributors +- Tasks can be converted into individual issues if needed. +- Feel free to suggest addional tasks or improvements. + + + +--- + +# Additional Information (optional) +[Include any screenshots, designs, or other supporting information here.] From f9d5f5209dea831a163ea3093f59e0627cefecfd Mon Sep 17 00:00:00 2001 From: ultimateownsz Date: Fri, 14 Feb 2025 14:51:38 +0100 Subject: [PATCH 3/4] update url & name refs --- .github/ISSUE_TEMPLATE/enhancement.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md index 2bcc388..61bf7c3 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -1,17 +1,17 @@ # Suggesting Enhancements -We welcome your ideas for improving PySeas! Whether it’s a new feature or a minor improvement, your contributions help shape the project. +We welcome your ideas for improving PyCeas! Whether it’s a new feature or a minor improvement, your contributions help shape the project. -For general contribution guidelines, see our **[Contributing Guide](/CONTRIBUTING.md)**. +For general contribution guidelines, see our **[Contributing Guide](https://github.com/PyCeas/Pyceas/blob/main/CONTRIBUTING.md)**. --- ## Steps for Submitting Enhancements -1. **Check the [Documentation](https://github.com/ultimateownsz/PySeas/tree/main/docs):** +1. **Check the [Documentation](https://github.com/PyCeas/Pyceas/tree/main/docs):** Ensure the feature doesn’t already exist. 2. **Search Existing Issues:** - Look through **[open issues](https://github.com/ultimateownsz/PySeas/issues)** to see if your idea has been proposed. + Look through **[open issues](https://github.com/PyCeas/Pyceas/issues)** to see if your idea has been proposed. 3. **Submit Your Suggestion:** - Use the **[Contributor Guide Template](.github/ISSUE_TEMPLATE/contributor_guide.md)** for small or straightforward enhancements. - Use the **[User Story-Based Template](.github/ISSUE_TEMPLATE/user_story_based_issue.md)** for larger or complex features that need to be broken into tasks. @@ -58,4 +58,4 @@ A zoom feature improves usability by making the minimap more versatile and user- - **Discussion:** Join us on **[Discord](https://discord.gg/your-server-link)** to share your thoughts. -Thank you for helping us improve PySeas! 😊 +Thank you for helping us improve PyCeas! 😊 From 202679680608092d855f786f793ffe47516e4d5c Mon Sep 17 00:00:00 2001 From: ultimateownsz Date: Fri, 14 Feb 2025 14:52:44 +0100 Subject: [PATCH 4/4] update url and other helpful info - url refs with old urls are updated - adds helpful tips what to do with the new pull request templates --- .github/pull_request_template.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ebb2f4c..3569d66 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,13 +1,17 @@ # Pull Request Template ## 📝 Instructions -Please choose the appropriate template based on the nature of your changes. Click one of the links below, copy the content of that template, and paste it into this pull request. +Please choose the appropriate template based on the nature of your changes. Use one of the following templates: + +- **[Code Changes Template](https://github.com/PyCeas/Pyceas/compare/main?expand=1&template=code_pr_template.md)** +- **[Documentation Changes](https://github.com/PyCeas/Pyceas/compare/main?expand=1&template=docs_pr_template.md)** +- **[Revert Previous Changes](https://github.com/PyCeas/Pyceas/compare/main?expand=1&template=revert_pr_template.md)** +- **[Asset Changes](https://github.com/PyCeas/Pyceas/compare/main?expand=1&template=asset_pr_template.md)** +- **[Audio Changes](https://github.com/PyCeas/Pyceas/compare/main?expand=1&template=audio_pr_template.md)** + +> ![IMPORTANT] +> When creating a pull request, make sure the base branch is set to `main`. If you are working from a different branch, you can update the target branch > in the pull request interface. -- **[Code Changes Template](https://github.com/ultimateownsz/PySeas/blob/main/.github/PULL_REQUEST_TEMPLATE/code_pr_template.md)** -- **[Documentation Changes](https://github.com/ultimateownsz/PySeas/blob/main/.github/PULL_REQUEST_TEMPLATE/docs_pr_template.md)** -- **[Revert Previous Changes](https://github.com/ultimateownsz/PySeas/blob/main/.github/PULL_REQUEST_TEMPLATE/revert_pr_template.md)** -- **[Asset Changes](https://github.com/ultimateownsz/PySeas/blob/main/.github/PULL_REQUEST_TEMPLATE/asset_pr_template.md)** -- **[Audio Changes](https://github.com/ultimateownsz/PySeas/blob/main/.github/PULL_REQUEST_TEMPLATE/audio_pr_template.md)** --- @@ -24,4 +28,4 @@ If you are not sure which template to choose, refer to the descriptions below: --- ## 🔗 Related Links -For more information, check the [Contributing Guidelines](/CONTRIBUTING.md) for details on submitting pull requests. \ No newline at end of file +For more information, check the [Contributing Guidelines](https://github.com/PyCeas/Pyceas/blob/main/CONTRIBUTING.md) for details on submitting pull requests. \ No newline at end of file