Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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).

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Provide additional context or background for this user story.
## Acceptance Criteria
<!-- Use checkboxes to define what needs to be true for the user story to be considered complete. -->
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

---

Expand All @@ -32,15 +32,15 @@ Each task represents an actionable step. Tasks can be converted into separate is

### Actionable Tasks
<!-- Define the steps or tasks needed to implement the user story. -->
- [ ] **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**:
Expand Down
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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! 😊
18 changes: 11 additions & 7 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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)**

---

Expand All @@ -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.
For more information, check the [Contributing Guidelines](https://github.com/PyCeas/Pyceas/blob/main/CONTRIBUTING.md) for details on submitting pull requests.
Loading