LittleTechBookClub / LittleTechBookClub/swarm-rest-api

Create BUG Issue Template for GitHub Repository to Enhance Async Communication with Slack Integration

Open
#28 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

devops
Dominant language
Java
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Description:
To improve asynchronous communication and streamline the issue creation process in our GitHub repository, we need to create an BUG_ISSUE_TEMPLATE.md file. This template will ensure that all necessary information is captured when an issue is created, enabling better tracking and integration with Slack notifications.

Acceptance Criteria:
Create ISSUE_TEMPLATE.md File:

The file should be located in the .github directory of the repository.

Template Structure:

The template should include the following sections:
Title: A clear and concise title for the issue.
Description: A detailed description of the issue, including the problem statement and any relevant background information.
Steps to Reproduce: A step-by-step guide on how to reproduce the issue.
Expected Behavior: A description of what the expected behavior should be.
Actual Behavior: A description of what the actual behavior is.
Screenshots/Logs: Any relevant screenshots or logs that can help diagnose the issue.
Environment: Information about the environment where the issue was encountered (e.g., OS, browser, version).
Slack Integration:

Ensure that the template is compatible with the existing Slack integration so that notifications follow the new structure.
Test the Slack notifications to confirm that all sections of the template are included in the messages.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Create the issue template under .github, first resolving whether the filename should be BUG_ISSUE_TEMPLATE.md or ISSUE_TEMPLATE.md. Review the existing Slack integration and its notification entry point, then test that the template sections appear in Slack notifications. Done means the template captures all listed fields and the notifications include them.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.