New Issue For GitHub Advisory Database

Nov 9, 2025 by Admin 39 views

Hey folks, this is a draft issue for the github/advisory-database repository. Think of this as a starting point. We're here to help you get your issues, feature requests, or advisories off the ground. So, to get things rolling, we need you to fill in some details. Let's make sure everything is crystal clear before we dive in. This initial post is just to get the conversation started. Let's work together to make sure this repository is the best it can be, yeah?

Type of Issue

First off, let's get straight to the point: what kind of issue are we dealing with? Is it a pesky bug that needs squashing, a cool feature you'd love to see added, or an important advisory we need to address? Maybe something else entirely? Knowing the type helps us categorize and prioritize things. When you're ready to submit your issue, please be specific. Is this a bug report? If so, tell us about the issue: when did it appear, what error messages showed up, and what steps did you take before you stumbled on the issue? Or, if you have a great idea to make things better, it could be a feature request. This will help the maintainers prioritize and understand the nature of your request, ensuring the most appropriate handling and allocation of resources. This initial categorization allows us to address the matter efficiently. It helps to set expectations and allows a quick analysis of the next steps. This initial classification process is vital for ensuring all aspects are considered before action. By identifying the specific issue type, we ensure the relevant teams are involved, which maximizes efficiency and responsiveness. Understanding the core issue helps in structuring the discussion, focusing on the most relevant aspects, and facilitating a collaborative problem-solving environment. When submitting your issue, consider whether it's a bug report, a feature request, or an advisory, and explain why you're suggesting it. Ensure the issue type aligns with the nature of your input and accurately reflects the purpose of your contribution. Making the distinction between these issue types helps in the streamlined management and processing of issues, thus creating a more efficient and user-friendly experience for all participants. If your issue is an advisory, it is critical for you to include the security details or the potential vulnerabilities that you want to address.

Bug Reports

If you're reporting a bug, provide detailed information about what went wrong. Include the following details:

Steps to reproduce: Describe the exact steps needed to encounter the bug. The more precise you are, the better we can understand and fix the issue.
Expected behavior: What should have happened instead?
Actual behavior: What did happen?
Environment: Specify your operating system, browser, and any other relevant software versions.

Feature Requests

For feature requests, outline the proposed feature and why it would be beneficial. Include:

Description: Clearly explain what the feature does.
Benefits: Detail how the feature improves the project.
Use cases: Provide examples of when and how the feature would be used.

Advisory Submissions

When submitting an advisory, remember that this is a sensitive area. Make sure to:

Vulnerability details: Describe the vulnerability, including its impact and severity.
Affected versions: List all affected versions of the software.
Mitigation: Explain possible solutions or workarounds.
Disclosure timeline: If you have a preferred disclosure timeline, include it.

Detailed Description of the Issue

Now, let's dive into the specifics. This is where you give us the lowdown on the problem, feature, or advisory. A clear and concise description is super helpful. Think of it as painting a picture for us. The more detail you provide, the easier it will be for us to understand and address your issue. Use this space to provide a comprehensive explanation of what you're reporting or requesting. Make sure to answer the basic questions: Who? What? Where? When? Why? and How? This section is important, since it will serve as the basis for further investigations, and to understand the context. Be as clear as possible when describing the issue, ensuring that the details are understandable and easily followed. Explain the purpose of your contribution and its relation to the overall project. A detailed description helps to ensure that all relevant information is provided, avoiding confusion and streamlining the resolution process. This part of the issue provides context and ensures a comprehensive understanding of the issue. The more detailed your description, the better the maintainers can understand the issue, reproduce it (if it's a bug), and formulate a proper solution. Take your time to write a detailed, understandable description.

Here are some tips for providing a good description:

Be clear and concise: Get straight to the point without unnecessary fluff.
Provide context: Give us some background information, like what you were trying to do when the issue arose or why you think the feature would be useful.
Use specific language: Avoid vague terms and use precise language to describe the issue.
Be objective: Stick to the facts and avoid emotional language.

By following these tips, you can help us to better understand your issue and work towards a solution. You can provide the context necessary for the team to properly understand and respond. Detailed descriptions also save time and help prevent misinterpretations, allowing for more efficient resolution of the issue. Consider your audience and write accordingly, making sure your description is accessible and easy to understand for everyone involved in the project. If there are any areas of uncertainty, feel free to highlight them and request clarification.

Steps to Reproduce or Background Context

Alright, next up: Steps to reproduce or background context. This section is crucial for bugs, but it's also helpful for feature requests and advisories. For bugs, give us the exact steps we need to take to experience the issue ourselves. For feature requests, explain the context or rationale behind the request. For advisories, describe the conditions under which the vulnerability can be exploited. If it's a bug, giving us the steps to reproduce it is like handing us the keys to unlock the problem. Think of it as a detailed recipe. The more detail you give us, the easier it is for us to replicate the issue and find a solution. If it's a feature request, tell us why it's needed and what problems it solves. Help us understand the context of the issue, and provide all necessary information so that we can evaluate the impact and scope of the reported problem. Provide enough information so that someone else can experience the issue. Providing clear reproduction steps helps the team to reproduce the issue, and this is a key step in resolving it. Think of this as a detailed guide that helps the team to replicate the issue. You should also ensure that the background context provides a foundation for others to understand the broader implications of the issue. When writing the reproduction steps, be as precise as possible. Include details like the operating system, browser, and software versions that you're using. If there are any special configurations or settings, be sure to mention them. Giving us these reproduction steps is a critical part of the process, as it allows the team to verify the issue and validate the proposed solutions. The aim is to provide a comprehensive guide that will allow anyone to experience the problem. Make sure your steps are detailed, and include all of the actions necessary to make the problem occur. It is very important that you provide the necessary information, so that the team will not have to guess.

Relevant Files, Links, or Screenshots

Got any helpful files, links, or screenshots? This is your chance to provide any extra information that might help us. Screenshots can be incredibly useful for illustrating the issue visually. Links to relevant documentation, code snippets, or online resources can provide additional context. Attaching any relevant files, such as log files or error reports, can give us valuable clues. You can provide any files, links, or screenshots that help the team to better understand your issue. This includes error messages, code snippets, or other pertinent data that can accelerate the troubleshooting process. Providing additional context through visual aids will enhance understanding. Providing these additional assets enhances understanding and accelerates the troubleshooting process. These elements offer crucial evidence and context, making the resolution process faster and more efficient. Providing these items will streamline the resolution process and speed up the investigation. Providing these items allows for a more detailed analysis and speeds up the resolution. Screenshots, files and links offer a more comprehensive understanding of the issue. This includes anything that can help us understand the issue at hand. Consider attaching relevant files, linking to documentation, or including any other useful items. By providing these additional elements, you're not just reporting an issue, you're helping us solve it. These elements will give context and help us in our investigations. Files such as log files or error reports can give insights into the root cause of the issue. These additional pieces of information can be very useful to the team, so make sure to provide them whenever possible. These items can give additional context and allow for a more detailed analysis of the problem. This additional information will help us better understand the situation. The goal is to provide enough information so that we can quickly understand the issue and move towards a solution.

Preferred Labels, Assignees, or Projects (If Applicable)

Do you have any preferred labels, assignees, or projects in mind? This section is optional, but it can be helpful. Labels help us categorize and organize issues. Assignees are the individuals or teams responsible for addressing the issue. Projects help us track the progress of issues. If you have any suggestions, feel free to include them. This will help us to manage and prioritize the issues efficiently, and will help the team to address the issues in a timely manner. This information helps us in organizing and managing the issues. This section gives you an opportunity to suggest labels, assignees, and projects for your issue. If you have suggestions for labels, it can help the team organize and categorize the issue, for example: bug, feature request, or security. The use of assignees helps in assigning the issues to the appropriate team members, and this helps the team members to quickly take action. If you have suggestions for projects, it can help the team to track progress. By providing these details, you can help us to manage and prioritize the issue. When providing suggestions, keep in mind the structure of the repository. Suggestions will help us manage and track issues more efficiently, ensuring that they are addressed and resolved in a timely manner. If you have suggestions for the labels, make sure to consider the nature of your issue. Consider the project's structure, and make suggestions accordingly. If you have suggestions, it can help the team to categorize the issue and assign it to the right team members, which can improve the overall efficiency of the project. If you have any preferences, you can include them in your issue.

That's it, guys! We're looking forward to reading your issues. We'll take a look and get back to you once you provide the necessary details. Your input is super valuable to us.