i have issue in my open source project of website. Website code is not working properly. (edited by moderator)
Hi @RosyLilly67 Welcome to the community!
We are happy you are here! You are more likely to get a useful response if you are explicit about what your project entails, giving a few more details might help someone give you a nudge in the right directions. For example, we encourage you to share the part of your source code or public repository that you would like help with.
@nyahbhinghiprincess, forgive me the slightly off-topic intrusion, but I’ve noticed that quite often new users are unaware of the info requirements that provide meaningful context to a question; so I thought: wouldn’t it be a good idea to provide some question guidelines in the actual typing box (i.e. an overlay text that isn’t actual content but just a reminder for the user, and which disappears when the user starts typing), or maybe even a full-fledged template (like we have for Issues here on GitHub).
These guidelines/templates might either be permanent or only be shown to new users (e.g. for the first 20 posts, or similar). IMO, they would be quite useful for new users, who would be provided with a checklist of the required info (user’s OS, links to repo/GH Pages sources/website, info and links about the tools mentioned, etc.)
@tajmone That is a good idea. Also, could you tell me the information requirements? I just want to make sure I am giving enough information.
If the problem occurs locally, providing info about the OS, Git version or Git GUI front end should be provided.
In case of GitHub Pages websites problems, links the both the source repository and the website should be provided (one of the two is often omitted in related questions).
In case of trouble with specific packages, languages or tools, links to their homepage as well as their version info should be offered (even if they are well known tools, end users trying to help should be spared having to google them, and direct links are always a time saver).
In general, newbies tend to omit links, which is often a deterrent in replying for it requires doing manual searches, so the guidelines should remind to provide links to anything that is being mentioned and is relevant to the topic discussed.
Of course, since the topics discussed here are broad, it won’t be possible to cover every possible scenario, but a couple of well though guidelines should be enough to set the posting user on the right track.
@tajmone posted a pretty a good list. At a higher abstraction, these are classic bug report questions:
- What are you doing?
- What is happening?
- What do you want/expect to happen instead?
If you answer all of those precisely that’s a pretty good start.
This could also be named the W3 Rule, to provide a mnemonic (along the lines of the famous Five Ws).
@tajmone That’s a good idea! The W3’s of bug reports? Interesting!