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

feat: introduce new design issue section #308

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

AnimeshKumar923
Copy link
Contributor

Description

  • This PR adds a new dedicated design issues section on the AsyncAPI GitHub issue page.

Related issue(s)
Resolves asyncapi/website#1721

Changes:
- add initial template for the design issue
@AnimeshKumar923
Copy link
Contributor Author

@Mayaleeeee I've opened this PR. Please describe the fields which should be present in the issue template.

cc: @sambhavgupta0705

@Mayaleeeee
Copy link
Member

@Mayaleeeee, I've opened this PR. Please describe the fields which should be present in the issue template.

cc: @sambhavgupta0705

Hello, @AnimeshKumar923. Thanks for the pinging.

I will respond to this tomorrow with the details.

@Mayaleeeee
Copy link
Member

Hey @AnimeshKumar923 thanks for all your hard work. I admire your patience and dedication. Below is how the design issue report section should look. I'd love to hear your suggestions. Thanks a bunch!

Design Issue Report 🎨

Issue Title:
[Brief, descriptive title of the issue]

Describe the Issue:
Please describe the design issue you’ve encountered clearly and concisely.

Expected Outcome:
What should the design look like, or how should it behave?

Screenshots:
Attach any screenshots or visuals that help illustrate the issue.

Steps to Reproduce:

  1. Open the Design File/Tool: [e.g., “Open the Figma file named ‘Homepage Design’.”]
  2. Go to the Issue Area: [e.g., “Navigate to the ‘Header’ section on the ‘Home’ page.”]
  3. Perform the Action: [e.g., “Change the font size of the text box.”]
  4. See the Result: [e.g., “Notice that the text overlaps with other elements.”]

Browser/Device:
What browser or device were you using?

Additional Notes:
Include any other relevant information or context.

Check Before Submitting:

  • I have looked for similar issues to avoid duplicates.

  • I have reviewed the Contributing Guidelines.

Would you like to help fix this issue? (Not required, but appreciated!)

  • Yes, I am interested in contributing to the fix.

  • No, I am just reporting the issue.

@AnimeshKumar923
Copy link
Contributor Author

@Mayaleeeee I have fever right now. I'll take a look at it in few days. Thanks!

@Mayaleeeee
Copy link
Member

@Mayaleeeee I have fever right now. I'll take a look at it in few days. Thanks!

Thank you @AnimeshKumar923
Get well soon 💜

Changes:

- update issue format according to the issue guideline
  provided here: asyncapi#308 (comment)
@AnimeshKumar923
Copy link
Contributor Author

Hi @Mayaleeeee
Just made the required changes via 645d1d7, PTAL,
Thank you for your patience!

@Mayaleeeee
Copy link
Member

Hi @Mayaleeeee
Just made the required changes via 645d1d7, PTAL,
Thank you for your patience!

Thanks, @AnimeshKumar923

I have reviewed the changes, and everything looks good. The only adjustment I would like to request is to keep lines 66-67 as they appear in the screenshot below and not to use the text I provided for those lines.

Screenshot_20240923_084510_GitHub.jpg

@AnimeshKumar923
Copy link
Contributor Author

Hi @Mayaleeeee
Just made the required changes via 645d1d7, PTAL,
Thank you for your patience!

Thanks, @AnimeshKumar923

I have reviewed the changes, and everything looks good. The only adjustment I would like to request is to keep lines 66-67 as they appear in the screenshot below and not to use the text I provided for those lines.

Screenshot_20240923_084510_GitHub.jpg

Hi @Mayaleeeee I've made the suggested changes through 70068d4, PTAL

@Mayaleeeee
Copy link
Member

Hi @Mayaleeeee
Just made the required changes via 645d1d7, PTAL,
Thank you for your patience!

Thanks, @AnimeshKumar923

I have reviewed the changes, and everything looks good. The only adjustment I would like to request is to keep lines 66-67 as they appear in the screenshot below and not to use the text I provided for those lines.

Screenshot_20240923_084510_GitHub.jpg

Hi @Mayaleeeee I've made the suggested changes through 70068d4, PTAL

Looks good @AnimeshKumar923
Thank you 🤗

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

Successfully merging this pull request may close these issues.

Introducing a Dedicated Design Issues Section on the AsyncAPI GitHub Issue Page
3 participants