-
Notifications
You must be signed in to change notification settings - Fork 521
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
Improve issue reporting #3364
base: development
Are you sure you want to change the base?
Improve issue reporting #3364
Conversation
Could the typo issue also include [BUG] in the title? Just so that it's grouped with the other bug related issues. I feel like it might get missed otherwise, since it's currently at the bottom of the list, below Project and Enhancement. |
Done :) Unfortunately I can't put it any higher, else I would. Sometimes GH is delightfully... opaque. |
Super minor nitpicks:
Slightly larger suggestion:
|
@larkgz |
also as I'm working on this, GitHub released a new UI for issue reporting. I'm not taking screenshots again, y'all can just go see what it looks like for yourselves - it's minor. |
About The Pull Request
Makes a variety of improvements to the reporting of issues on the repo. To see this in action, head to my repo's Issues tab
Splits issues into the relevant groups ahead of players reporting.
![image](https://private-user-images.githubusercontent.com/48025294/403515921-479ebe24-5491-48de-a585-d8d7a53b6ec6.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MTkwMzEsIm5iZiI6MTczOTYxODczMSwicGF0aCI6Ii80ODAyNTI5NC80MDM1MTU5MjEtNDc5ZWJlMjQtNTQ5MS00OGRlLWE1ODUtZDhkN2E1M2I2ZWM2LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMTUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjE1VDExMjUzMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTI3MzYzNTBmYmZmNjNmN2Y2NDM2YjBhZTU5NGI3Mzc1NmRlOTBmY2YzMTJlNjQ5ZWVmNzQyOTVlNGVhMWRjNmImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.wqqSoVajepgXOe6bgkCVIq_y1RLbi_XhNX9NeLme4nY)
Appropriately tags the issues with the right labels to make searching easier (this will also include the
![image](https://private-user-images.githubusercontent.com/48025294/403516226-bba11b38-f5d5-4b2c-a46b-8300f88e298a.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MTkwMzEsIm5iZiI6MTczOTYxODczMSwicGF0aCI6Ii80ODAyNTI5NC80MDM1MTYyMjYtYmJhMTFiMzgtZjVkNS00YjJjLWE0NmItODMwMGY4OGUyOThhLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMTUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjE1VDExMjUzMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTFhNTUxOTYwNTNkZWRmZGE2NDc3YzY3ODkzYzZiNGRlNWZiOTkyZjE0YmU1OGM4Mjk0ZmE2ZTdkNGUxNGQ2NzMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.-OuwYz4-4wyYdtNba09RHdBZLP5W96VMCmVCU-MLVX8)
visual
tag on main branch, it just doesn't in mine because I don't have it)Confirm prerequisites
![image](https://private-user-images.githubusercontent.com/48025294/403524553-8093c945-1127-460e-8a2e-8362b7218de6.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MTkwMzEsIm5iZiI6MTczOTYxODczMSwicGF0aCI6Ii80ODAyNTI5NC80MDM1MjQ1NTMtODA5M2M5NDUtMTEyNy00NjBlLThhMmUtODM2MmI3MjE4ZGU2LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMTUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjE1VDExMjUzMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTkzMTc2YjZkMWEzZjJiZmI0ZDUwMzNiOTQ3YmI5YTFhMDhjMDViZDUwZDg1NTVhZWJiMWIzOTgzZmQ1NWQwOWYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.cZVtwPB-lfVgQiqjcETHDCRuAb_e9g5Q3b-knwHW_Po)
Uses a more appropriate default severity (we can't have an empty field that can stop players submitting, so this is a compromise)
![image](https://private-user-images.githubusercontent.com/48025294/403516451-6cb8c4a9-e119-440b-8da1-5a487b61e45b.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MTkwMzEsIm5iZiI6MTczOTYxODczMSwicGF0aCI6Ii80ODAyNTI5NC80MDM1MTY0NTEtNmNiOGM0YTktZTExOS00NDBiLThkYTEtNWE0ODdiNjFlNDViLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMTUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjE1VDExMjUzMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTFmNTIxZmQwZTUwYThkNzQzMTQxOWU2OWVhY2VhZDRjZjM3NmFlZjI2MTdhZjk5YTY2OTNkMzIzMGUyZmJhZjkmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.M5Ct2vWAyG8MdNaqiJu2_SyLWpnzKoMMFvEl_OGN-U4)
Shows questions that are relevant to the specific issue that is being reported (UI questions ask about fullscreen, for example).
![image](https://private-user-images.githubusercontent.com/48025294/403516863-19dbd581-3d45-4f01-b62f-3c3c13979dc6.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk2MTkwMzEsIm5iZiI6MTczOTYxODczMSwicGF0aCI6Ii80ODAyNTI5NC80MDM1MTY4NjMtMTlkYmQ1ODEtM2Q0NS00ZjAxLWI2MmYtM2MzYzEzOTc5ZGM2LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMTUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjE1VDExMjUzMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWU4ZTAyYWZlMmFhNzczNTVmZGFjZGEwMmVjNDQ0YTM3ZDNiNDY3NmZkNjRjNWQ0YjQyNzM5YTI2ZDU4YTIxOWQmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.V1s1C2V8BTaABrV4tTxgMw_TIEbXQM0W-SB5TZojGjQ)
Why This Is Good For ClanGen
Asking the appropriate questions without making the form overwhelming is a balance to strike, especially since we can't have conditional sections (thanks GitHub...). Splitting them up allows us to ask more meaningful questions, tag things appropriately ahead of time, etc.
Changelog/Credits