Welcome to our Q&A! 💬

[DennisDyallo]

Hello and welcome to the Q&A forum for the Yubico.NET.SDK!

This is the best place to ask for help if you're stuck on a specific problem, have a question about how to use the SDK, or are running into an error. By asking and answering questions here, you help create a valuable knowledge base for everyone in the community.

💬 Q&A vs. 🐞 Issues: Which one to use?

To keep the project organized, it's important to distinguish between a question and a bug report. Please use this guide to decide where to post.

➡️ Use Q&A for:

• ❓ "How do I...?" questions: You need help using the SDK to accomplish a task.
• 🤔 Understanding Concepts: You want to know why the SDK is designed a certain way.
• 💡 Troubleshooting Your Code: You are getting an error and you suspect the problem might be in your implementation, not in the SDK itself.

➡️ Create an Issue for:

• 🐞 Reporting a Bug: You have found a reproducible problem where the SDK crashes, produces an incorrect result, or does not behave as documented.
• 🔐 Reporting a Security Vulnerability: (Please follow the instructions in our SECURITY.md file).
• ✨ A Confirmed Feature Request: Note: It's often best to discuss new features in the "Ideas" forum first.

If you're not sure, it's always okay to start here in Q&A! If the community determines that your problem is a genuine bug in the SDK, we will help you create a well-formed GitHub Issue.

---

How to Ask a Great Question

The more information you provide, the faster the community can help you. When you create a new question, please try to include the following:

• ✔️ A Clear, Specific Title
  A good title helps others with the same problem find your question.

  • Good: How do I get the serial number from a YubiKey using the PivSession?
  • Bad: Help with SDK

• ✔️ Describe Your Goal
  Briefly explain what you are trying to achieve. Sometimes the problem isn't in the code, but in the approach.

  • Example: "I'm building a settings page where I need to display the serial number of the connected YubiKey to the user."

• ✔️ Show What You've Tried
  Share a minimal code snippet that reproduces your issue. This is the most important step! It allows others to run your code and debug the problem directly.

• ✔️ Include Errors and Versions
  If you're getting an error, please paste the full error message and stack trace. Also, let us know your environment details:

  • Yubico.NET.SDK version (e.g., 4.2.0)
  • .NET version (e.g., .NET 8.0)
  • Operating System (e.g., Windows 11, macOS Sonoma)
  • YubiKey model and firmware (if you know it)

Did You Get Your Answer? ✅

Once your question has been answered and your problem is solved, please help the community by clicking the "Mark as answer" button on the reply that helped you the most.

This does two great things:

1. It lets everyone know your issue is resolved.
2. It highlights the correct solution for future visitors who may have the same question.

Thank you for being a part of the community. We look forward to your questions!