Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Task Template #73

Open
Keyrxng opened this issue Oct 28, 2024 · 4 comments
Open

New Task Template #73

Keyrxng opened this issue Oct 28, 2024 · 4 comments

Comments

@Keyrxng
Copy link
Member

Keyrxng commented Oct 28, 2024

Background & Importance

Provide a brief explanation of why this task is significant, with links to relevant discussions, PRs, or issues as needed.

Problem Evidence

Add supporting evidence such as:

  • Source code links
  • Screenshots or images
  • Reference PRs or related tasks

Proposed Solution (if applicable)

Outline any suggested solutions, including:

  • Code-related ideas or documentation links
  • Descriptions of methods or approaches

Task Requirements

List clear, actionable steps to complete the task:

  1. Step 1
  2. Step 2
  3. Step 3

Cite relevant sources or contributions:

  • Originally posted by @username
  • Original [context](URL to source or discussion)

Formatting & Quality Tips

  • Concise & Clear: Be direct and to the point.
  • Organized Structure: Use headers and bullets.
  • Examples & Links: Support with relevant links.
@0x4007
Copy link
Member

0x4007 commented Oct 28, 2024

Any link is appropriate but perhaps I am not understanding what you mean.

Generally high quality communication includes:

  • background context (why is this important?)
  • examples (code snippets, images, links)
  • organized and concise thoughts

@Keyrxng
Copy link
Member Author

Keyrxng commented Oct 28, 2024

Any link is appropriate but perhaps I am not understanding what you mean.

I thought there was a specific format for the footer for them to give credit but it's just any URL in the footer will credit the author of that comment or the author of the Task/PR if it's not a comment specific link?

@0x4007
Copy link
Member

0x4007 commented Oct 28, 2024

It's whatever is generated by GitHub when "referencing in a new issue"

@Keyrxng
Copy link
Member Author

Keyrxng commented Oct 28, 2024

@0x4007 updated the template

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants