Improve Issue and Pull Request Templates

[coderabbitai]

Enhance issue and pull request templates based on the current structure that most examples have, including tasks needed for the expected format.

Related PR: #2703
Requested by: @ReneWerner87

[ReneWerner87]

@coderabbitai please carry out the tasks theoretically and indicate the possible adjustment

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@ReneWerner87, based on your request to improve the issue and pull request templates, here are some theoretical adjustments that could enhance them:

---

Issue Template Improvements:

• Add Sections for Better Clarity:
  • Description: A clear and concise description of the issue.
  • Steps to Reproduce: Detailed steps to replicate the issue.
  • Expected Behavior: What should happen.
  • Actual Behavior: What actually happens.
  • Environment Details: Including Fiber version, Go version, and OS.
  • Screenshots/Logs: Any relevant visual aids or logs.

Example Issue Template:

# Description

<!-- Please provide a clear and concise description of the issue. -->

# Steps to Reproduce

1. <!-- Step one -->
2. <!-- Step two -->
3. <!-- ... -->

# Expected Behavior

<!-- Describe what you expected to happen. -->

# Actual Behavior

<!-- Describe what actually happened. -->

# Environment

- **Fiber Version:** <!-- e.g., v2.42.0 -->
- **Go Version:** <!-- e.g., go1.17 -->
- **Operating System:** <!-- e.g., Windows 10 -->

# Screenshots / Logs

<!-- If applicable, add screenshots or paste log outputs here. -->

# Additional Context

<!-- Add any other context about the problem here. -->

---

Pull Request Template Improvements:

• Structured Sections for Consistency:
  • Description: Summary of the changes and motivation.
  • Related Issues: References to any related issues.
  • Proposed Changes: Detailed description of changes.
  • Checklist: Ensure all necessary steps are completed.

Example Pull Request Template:

# Description

<!-- Please include a summary of the changes and the motivation behind them. -->

# Related Issues

<!-- List any related issues (e.g., Fixes #123, Closes #456). -->

# Proposed Changes

- <!-- Detailed list of changes -->
- <!-- ... -->

# Checklist

- [ ] I have read the [Contributing Guidelines](CONTRIBUTING.md)
- [ ] I have updated the documentation where necessary.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] I have formatted my code using the project's code style guidelines.
- [ ] I have run the test suite and all tests pass.

---

Possible Adjustments:

• Link to Contribution Guidelines: Ensure that contributors are aware of and adhere to the project's contribution standards by providing links within the templates.

• Emphasize Test Coverage: Encourage contributors to include tests for new features or bug fixes.

• Use Comments for Guidance: Utilize HTML comments (<!-- -->) within the templates to guide contributors without affecting the rendered content.

• Localization Support: If applicable, consider adding notes about supporting multiple languages or locales.

---

Implementing these enhancements should streamline the issue reporting and pull request submission process, making it easier for both contributors and maintainers to collaborate effectively.

Let me know if you'd like to proceed with these adjustments or have any further suggestions!

[ReneWerner87]

@coderabbitai consider also the contribution markdown with the tasks
And also mention this

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@ReneWerner87, thank you for bringing the CONTRIBUTING.md file to my attention. I've reviewed its contents and have incorporated the tasks outlined within it into the proposed improvements for the issue and pull request templates.

---

Issue Template Enhancements:

• Reference Contribution Guidelines:
  • Include a link to the CONTRIBUTING.md to ensure contributors are aware of the guidelines.
  • Add a checklist to confirm they've read and followed the contribution steps.

Example Issue Template:

# Description

<!-- Please provide a clear and concise description of the issue. -->

# Steps to Reproduce

1. <!-- Step one -->
2. <!-- Step two -->
3. <!-- ... -->

# Expected Behavior

<!-- Describe what you expected to happen. -->

# Actual Behavior

<!-- Describe what actually happened. -->

# Environment

- **Fiber Version:** <!-- e.g., v2.42.0 -->
- **Go Version:** <!-- e.g., go1.17 -->
- **Operating System:** <!-- e.g., Windows 10 -->

# Screenshots / Logs

<!-- If applicable, add screenshots or paste log outputs here. -->

# Contributing Checklist

- [ ] I have read the [Contributing Guidelines](https://github.com/gofiber/recipes/blob/master/.github/CONTRIBUTING.md).
- [ ] I have searched the [issues](https://github.com/gofiber/recipes/issues) and found no similar issues.

# Additional Context

<!-- Add any other context about the problem here. -->

---

Pull Request Template Enhancements:

• Integrate Tasks from CONTRIBUTING.md:
  • Emphasize specific steps for adding new examples as per the guidelines.
  • Provide a structured checklist to ensure all tasks are completed.

Example Pull Request Template:

# Description

<!-- Please include a summary of the changes and the motivation behind them. -->

# Related Issues

<!-- List any related issues (e.g., Fixes #123, Closes #456). -->

# Proposed Changes

- <!-- Detailed list of changes -->
- <!-- ... -->

# Contribution Tasks

Please ensure you have completed the following tasks as outlined in the [Contributing Guidelines](https://github.com/gofiber/recipes/blob/master/.github/CONTRIBUTING.md):

1. **Created a Directory**: Added a new directory for your example in the root of the repository without a "fiber" prefix.
2. **Added a `README.md`**:
   - Included Docusaurus metadata at the top:
     ```markdown
     ---
     title: Your Example Title
     keywords: [keyword1, keyword2]
     ---
     ```
   - Provided detailed explanations, components used, and instructions.
3. **Updated the Overview**: Ran `make generate` in the root directory to update the table of contents.

# Checklist

- [ ] I have read the [Contributing Guidelines](https://github.com/gofiber/recipes/blob/master/.github/CONTRIBUTING.md).
- [ ] I have formatted my code according to the project's code style guidelines.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] I have updated the documentation where necessary.
- [ ] I have run the test suite and all tests pass.

---

By incorporating the tasks from the CONTRIBUTING.md, we ensure that contributors follow the established procedures, which helps maintain consistency and quality across the project. Linking directly to the guidelines and providing clear checklists will make the contribution process more transparent and efficient.

Please let me know if you'd like any further adjustments or additions!

🔗 Analysis chain

---

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Display the contents of the CONTRIBUTING.md file
cat CONTRIBUTING.md

Length of output: 69

---

Script:

#!/bin/bash
# Find any markdown files related to contribution guidelines
fd -H -I --type f --regex '.*contribut.*\.md$'

# Display the contents of any found files
fd -H -I --type f --regex '.*contribut.*\.md$' --exec cat {} \;

Length of output: 1521

---

✏️ Learnings added

Learnt from: ReneWerner87
URL: https://github.com/gofiber/recipes/issues/2705

Timestamp: 2024-11-26T20:05:15.542Z
Learning: For future contributions to the `gofiber/recipes` repository, ensure that the tasks outlined in `.github/CONTRIBUTING.md` are incorporated, including creating a new directory without a "fiber" prefix, adding a `README.md` with Docusaurus metadata, and updating the overview by running `make generate`.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.