⭐Best Practice for Maintainers

Sample issue: https://github.com/delphidigital/delphi-tg-bots/issues/35

1. Title:

• Be descriptive and concise.

• Use imperative language ("Fix," "Add," "Update") to indicate action.

• Include relevant keywords.

2. Description:

• Provide a clear overview of the problem or task.

• Include any relevant background information.

• Specify the expected behavior or outcome.

• Use bullet points or numbered lists for clarity.

• Include any constraints or requirements.

3. Steps to Reproduce (for bugs):

• If it's a bug report, provide clear steps to reproduce the issue.

• Include any error messages or screenshots, if applicable.

• Specify the environment (OS, browser, etc.) where the issue occurred.

4. Acceptance Criteria (for tasks):

• Clearly define what constitutes a completed task.

• List specific deliverables or goals.

• Provide examples or references if necessary.

• Mention any criteria for code quality, testing, or documentation.

5. Labels:

• Use labels to categorize issues (e.g., bug, enhancement, documentation).

• Add labels for priority (e.g., high priority, low priority).

• Consider using labels for difficulty level (e.g., beginner-friendly).

7.. Related Issues and Pull Requests:

• Link related issues or pull requests for context.

• Mention if the issue is dependent on or related to other tasks.

• Ask the developer to create a video (ie, using loom) to be included with the pull request. The video should show the feature in action and allow the developer to explain any decisions they made.

8. Documentation:

• If applicable, provide links to relevant documentation or resources.

• Include any relevant code snippets or examples.

• Clarify any terminology or concepts if needed.

9. Closure:

• Close the issue once it's resolved or implemented.

• Provide feedback and thanks to the contributor who addressed the issue.

• Encourage contributors to reopen the issue if problems persist.