dtxe / dsi_git_assignment Goto Github PK
View Code? Open in Web Editor NEWLicense: Other
License: Other
When creating a GitHub Issue or bug report, include the following key items for developers:
Title:
Concise summary of the issue.
Description:
Detailed explanation of the problem or feature request.
Steps to Reproduce:
Clear steps to recreate the issue.
Environment Details:
Operating system, browser, or relevant software versions.
Screenshots or Code Snippets:
Visual aids for better understanding.
Expected vs. Actual Behavior:
Clearly state expected outcome versus observed result.
Reproducibility:
Indicate if the issue is consistent or sporadic.
Logs and Error Messages:
Include relevant logs or error messages.
Version Information:
Specify the version of the software or application.
Labels:
Add appropriate labels for categorization.
Crafting an effective bug report is crucial for the swift resolution of software or application issues. A well-constructed report equips developers with the necessary details to identify, replicate, and resolve problems efficiently. Here are essential steps and recommendations to guide you in creating a clear and actionable bug report:
1. Title Clarity:
2. Detailed Environment Information:
3. Steps to Reproduce:
4. Expected and Actual Results:
5. Include Visual Media:
6. Additional Context:
7. Check for Duplicates:
8. Use Standardized Formats:
9. Maintain Courtesy and Professionalism:
10. Test and Verify:
Adhering to these guidelines enhances the effectiveness of bug reports and contributes to a more efficient debugging and resolution process.
Criteria for a good bug report:
A bug report should include a description of the issue and details on the step at which the issue occurs, the expected behavior, and all logs, errors, and screenshots that can assist the developer in identifying and resolving the issue. Additionally, include a sample dataset and code to help reproduction of the issue.
Creating a comprehensive GitHub issue or bug report is crucial for developers to understand, reproduce, and ultimately fix the reported bug efficiently. Here are the key items to include:
In a bug report, provide
Description:
There are no arrow buttons to change the load order. You can't drag and drop them either. Also there are no numbers for the load order.
NMM Version: 0.86.0
Mods:
Baldur's Gate 3 No more clothes for females + NPC private parts - bg3_npc_f_private_parts_2.0.3.7z
https://www.loverslab.com/topic/216228-baldurs-gate-3-no-more-clothes-for-females-npc-private-parts/
4X Carry Weight - 4XCarryWeight-261-1-01-1635519690.zip
<( No Longer Visible )>
Arcane Rings-112-1-6-1646277424.zip
https://www.nexusmods.com/baldursgate3/mods/112
BasketEquipmentNSFW-97-1-1-5-1703449798.zip
https://www.nexusmods.com/baldursgate3/mods/97
BonAppetit-337-1-0-1657303719.zip
https://www.nexusmods.com/baldursgate3/mods/337
Padme's Character Creation Added Colours - CCAddedColours-115-2-3-1619881072.zip
<( No Longer Visible )>
Community Library-1333-2-2-4-0-1706656812.zip
https://www.nexusmods.com/baldursgate3/mods/1333
Compatibility Framework-1933-2-6-3-11-1706165364.zip
https://www.nexusmods.com/baldursgate3/mods/1933
Crispy Map - Double Resolution of World Map - CrispyMap-2-1-0-0-1602892473.7z
<( No Longer Visible )>
No More Dirt And Blood - Slower and Faster Options - Disabled Dirt And Blood-344-1-1657935631.rar
https://www.nexusmods.com/baldursgate3/mods/344?tab=description
Eldritch Blast Extreme Knockback - Eldritch Blast Loose Files-78-1-0-1604256611.zip
https://www.nexusmods.com/baldursgate3/mods/78
Enhanced Nude Bodies - Humans Elves Half-Elves Drows (Normal)-652-1-1-1691496592.7z
https://www.nexusmods.com/baldursgate3/mods/652
ImprovedUI ReleaseReady - ImprovedUI-366-3-17-1704833332.zip
https://www.nexusmods.com/baldursgate3/mods/
ImprovedUI ReleaseReady - ImprovedUI Assets-366-3-17-3-1-1705780988.zip
https://www.nexusmods.com/baldursgate3/mods/366?tab=files
Baldur's Gate 3 Mod Fixer - Mod Fixer-141-1-0-1692715645.zip
https://www.nexusmods.com/baldursgate3/mods/141
5e Monster Slayer - Ranger Subclasss (Plus New Spells) - MonsterSlayer5e.zip-5842-2-5-0-1705948736.zip
https://www.nexusmods.com/baldursgate3/mods/5842
More Vampire Bites - MoreVampireBites.pak-18-2-2-1603652031.zip
https://www.nexusmods.com/baldursgate3/mods/18
Native Mod Loader - NativeModLoader-944-1-1692533783.zip
https://www.nexusmods.com/baldursgate3/mods/944
Nudity - Nudity.zip-46-1-0-0-1603659037.zip
https://www.nexusmods.com/baldursgate3/mods/46
Raven Queen's Chosen - Shadar-Kai - Shadar-Kai-1305-2-3-0-1693612103.zip
https://www.nexusmods.com/baldursgate3/mods/1305
Better Thorn Whip Damage - ThornWhipDamageUp-240-1-1629582279.zip
https://www.nexusmods.com/baldursgate3/mods/240?tab=description
A well-documented bug report should contain the following elements:
1. Title: A concise and descriptive title that summarizes the issue.
2. Description: A detailed explanation of the bug, including reproducing the bug, what happened wrong etc.
3. Environment: Any information regarding the system (Windows, Mac), browser/hardware/software used
4. Supporting evidence: Any screenshot or other supporting media files
5. Error Messages : Error message received; details of log
1. Title
A clear brief description of what the issue is and where it occurs.
2. Context
Showing the steps that led you to get the bug, including your code, input and data source. Comparing the expected behaviour vs. the actual behaviour.
3. Error message or Log:
Include any error message, or log file associated with the issue.
4. Supporting artifacts
Screenshots, error messages and debugging logs
A comprehensive GitHub issue or bug report should include a concise title, detailed steps to reproduce, environment specifics, version information, reproducibility details, visual aids like screenshots, relevant code samples, error logs, a comparison of expected vs. actual behavior, and any additional context.
When reporting a bug or issue on GitHub, it's important to provide as much information as possible to help the developer understand and reproduce the problem. Here are some key items that should be included in a GitHub issue or bug report:
Title: A clear and concise title that summarizes the issue. The title should be such that by reading these few words, the developer understands the context of the issue.
Steps to Reproduce: Detailed steps on how to reproduce the bug. This should be as specific as possible, including any relevant input data or user actions.
Expected Behavior: A description of what you expected to happen when you followed the steps to reproduce.
Actual Behavior: A description of what actually happened. Include any error messages or screenshots if applicable.
Environment: Information about the environment in which the bug was encountered, such as:
Reproducibility: How consistently the bug can be reproduced. Is it always reproducible, or does it happen intermittently?. If possible (and applicable) include a dockerfile
which will create a docker image and the bug can be reproduced in the container
. Sometimes it saves considerable amount of time helping the developer reproduce the error and use the same docker
container to even fix the problem as this is a isolated environment.
Frequency: How often does the bug occur?
Impact & Priority/Severity: What is the impact of the bug? Is it a minor inconvenience, or does it prevent certain features from working? Indicate the impact of the bug on the system or users.
Possible Solution: If you have an idea of how the bug could be fixed, you can include that here. However, this is not always necessary.
Related Issues: If there are any other issues that are related to this one, link to them.
Assigned Developer: Assign the bug to a specific developer or team responsible for fixing it.
Labels: Use labels to categorize the issue (e.g., bug, enhancement, feature request) for easier tracking and prioritization.
Additional Context: Any other information that might be relevant to the bug, such as whether it was introduced in a recent update, or if it's happening for multiple users.
Bug Reports:
A well-written issue includes clear context, reproducible examples, and detailed descriptions for bugs.
Feature Requests:
For feature requests, it encompasses an overview, user scenarios, a mockup, and details about the existing workflow.
A well-written GitHub Issue or bug report will provide a clear and concise summary of what you are trying to accomplish and a reproduceable result; specifically what happened and what you expected to happen. The reproduceable result should include any relevant code snippets, datasets, or other files required for the result and any error logs or messages that are corresponding with the execution of your code.
If a reviewing-developer can fully understand what you were trying to do, what you ultimately did, and what happened afterwards, then they can easily diagnose and fix the bugs within your code!
Some of the key items that should be included in a GitHub Issue or bug report include:
Clearly describe the problem that one is having, while providing the necessary information regarding the environment the issue is taking place (e.g., the issue occurred while updating versions XXX).
Since GitHub is a community, asking for help is important- especially asking for feedback from specific people who may have an idea. Therefore, adding code errors or screenshots of the problem may help the community assist one faster.
Additionally, when writing the issue, it is important to keep the message clear and concise, and that titles be short and descriptive.
A GitHub issue can have a title, description of the issue, specific collaborators, labels etc.
The title should describe and convey the issue quickly. The description explains the purpose of the issue and how to potentially resolve it.
If it's a bug fix, include a reprex. A reprex is a REPRoducible EXample. It contains the code to reproduce just the error. It only includes what is related to the issue. You can include a minimal dataset to demo the problem. Also it must include the classes, and packages, which are placed at the top.
Other things to include is details about the issues you are facing, comments that will clarify the error, what has been attempted to fix the error, including pages to StackOverflow articles that have been viewed.
If the issue is big, it is possible to break the task down into smaller pieces, by creating task lists, by creating square brackets and marking it complete by using an [x]. Issues can be linked to previous issues by using numbers or a URL.
File annotation can help resolve issues if its is known where the issue is. “git blame” shows us when code was introduced and by whom, line by line. “git bisect” can help get the identify of the commit that introduced the issue.
Followings are the most key items that your report should have:
1- Clear and concise Title
a brief description of what the bug is, and where it occurs.
2- Short Summary
This is in case your description at the title section is not enough. This might a short summary to include additional items that your teammate will need (i.e date, time, and specific items triggered the bug )
3-What is causing the bug?
This should show steps that led you to get the bug and what was your code, input, data source, and any configuration relevant to the issue.
4- Error message or Log:
Include any error message, or log file associated with the issue.
5-Additional Information:
Any other details need to be added such as expected behavior, screenshots, previous change request id, or similar bugfix id.
Question: What key items should be included in a GitHub Issue or bug report to enable a developer to diagnose and fix the bug?
Answer:
An issue should have a concise title, a detailed description of the issue, a list of steps to reproduce the issue, information about the environment in which the bug was observed, any screenshots (visuals tremendously aid in finding problems), and a copied and pasted text of the bug message output itself - this step will help the developer pinpoint the exact location of the bug.
Key Items for issues like Bug Report or Feature:
Bug Report:
Context: describe what are you trying to do overall?
Reproducible example:
• include enough code and a sample dataset to reproduce the error;
• describe what was the behavior of the code;
• describe what is the expected behavior of the code;
• includes screenshots, error messages, and debugging logs.
Feature requests:
Creating a detailed GitHub issue or bug report helps developers diagnose and fix the bug efficiently, the key items that should be included are the following:
The above key items in the GitHub issue or key report, the developers will understand, diagnose, and fix the bug effectively.
Q: What key items should be included in a GitHub Issue or bug report to enable a developer to diagnose and fix the bug?
What key items should be included in a GitHub Issue or bug report to enable a developer to diagnose and fix the bug?
A: When creating a github issue, you should write a few key things to ensure the usefulness of the issue report
You should explain what the issue is and what it is for
You should explain steps that need to be taken to reproduce the error
Explain the behaviour of the issue as well as the expected behaviour
Include screenshots, videos, error logs, etc. that will help
Indicate any other important information that could be helpful such as frequency of issues, version history, or any previously attempted solutions
Key items of a bug report required for a developer to debug or fix an issue
Software version error is happening
Steps to reproduce the error
environment such as OS, browser name and version
Screenshot of the error
An issue post should be concise, yet descriptive. It should effectively communicate what the issue is, and, if possible, the contributor's thoughts on how to resolve the issue. If the issue concerns a bug in code, post could include a reproducible example that illustrates what the contributor thinks the code should do, and how the code is currently behaving.
When creating a GitHub Issue or bug report, it's important to include the following key items to help developers diagnose and fix the bug effectively:
The goal is to give out a reproducible example.
To achieve that, one can include code and a sample dataset for others to reproduce the error in the github issue.
One should also explain the current outcome of the code and the expected outcome of this code.
To make the issue clearer, one should also include screenshots, error messages and logging details in the issue.
Issues should include what is the issue and how it can be fixed
For a developer to diagnose and fix a bug, the GitHub Issue or bug report should include the three basic components: what you did, what happened, and what you expected to happen. The Issue or bug report should provide the context (what you are trying to achieve and how) as well as a reproducible example (enough code or dataset sample to reproduce the error, the current and expected outcome, along with supporting screenshots, error messages or debugging logs).
Question: What key items should be included in a GitHub Issue or bug report to enable a developer to diagnose and fix the bug?
Answer: The key items should be title, short description, environment, screenshots or the recordings of the reproduction of the issue, expected and current behavior, additional relevant context and error messages. This will help developer to understand and fix the bug.
Both of these require context
Context: What is it that is being done overall?
Reproducible example:
Git Assignment - Short Answer - Ka Ho (Gerald)
What key items should be included in a GitHub Issue or bug report to enable a developer to diagnose and fix the bug?
From page 14, 15 of Working in software teams lecture slides
Bug reports
Feature requests
My Addition:
Bug reports
Feature requests
Question: What key items should be included in a GitHub Issue or bug report to enable a developer to diagnose and fix the bug?
Submit your short answer as a GitHub issue in this repo https://github.com/dtxe/DSI_git_assignment.
What key items should be included in a GitHub Issue or bug report to enable a developer to diagnose and fix the bug?
Title, environment information, steps to reproduce the issue, expected behaviour, visuals of the issue, analysis of the cause of the issue.
What key items should be included in a GitHub Issue or bug report to enable a developer to diagnose and fix the bug?
While reporting a bug or issue. Following items should be considered while writing a message :-
1.Provide the contex regarding issue such as the function/section of code where the issue has occured.
2.Input parameter to code, expected output and result we are getting at present.
3.If possible share the impact of issue on other code/section.
Such information will developer to better understand the issue and fix them.
#What key items should be included in a GitHub Issue or bug report to enable a developer to diagnose and fix the bug?
The assignment wants us to answer here, instead of a plain old boring Google Doc
A Github Issue is to have context, reproducible examples and include screenshots/error messages.
Some reproducible examples include:
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.