diff --git a/.github/ISSUE_TEMPLATE/contributor_guide.md b/.github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/contributor_guide.md similarity index 94% rename from .github/ISSUE_TEMPLATE/contributor_guide.md rename to .github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/contributor_guide.md index 8cccf17..12c894c 100644 --- a/.github/ISSUE_TEMPLATE/contributor_guide.md +++ b/.github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/contributor_guide.md @@ -9,7 +9,7 @@ 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. +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 @@ -70,7 +70,7 @@ Thank you for your interest in contributing to PySeas! This guide will help you **Example:** - Code snippet: `/player_movement.py` line 45. -- Related issue: [Issue #123](https://github.com/ultimateownsz/PySeas/issues). +- Related issue: [Issue #123](https://github.com/example/repo/issues/123). --- diff --git a/.github/ISSUE_TEMPLATE/user_story_issue_template.md b/.github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/user_story_based_issue.md similarity index 92% rename from .github/ISSUE_TEMPLATE/user_story_issue_template.md rename to .github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/user_story_based_issue.md index ee9c790..b829773 100644 --- a/.github/ISSUE_TEMPLATE/user_story_issue_template.md +++ b/.github/ISSUE_TEMPLATE/.github/ISSUE_TEMPLATE/user_story_based_issue.md @@ -21,9 +21,9 @@ 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] +- [ ] Criterion 1 +- [ ] Criterion 2 +- [ ] Criterion 3 --- @@ -32,15 +32,15 @@ Each task represents an actionable step. Tasks can be converted into separate is ### Actionable Tasks -- [ ] **Task 1: [Brief description]** +- [ ] Task 1: Brief description - **Details**: - **Files/Modules Affected**: - **Related Resources**: -- [ ] **Task 2: [Brief description]** +- [ ] Task 2: Brief description - **Details**: [Optional: Additional context or requirements for this task.] - **Files/Modules Affected**: - **Related Resources**: -- [ ] **Task 3: [Brief description]** +- [ ] Task 3: Brief description - **Details**: - **Files/Modules Affected**: - **Related Resources**: 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! ๐Ÿ˜Š 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