Watch videos with subtitles in your language, upload your videos, create your own subtitles! Click here to learn more on "how to Dotsub"

Getting started in the issue queue

0 (0 Likes / 0 Dislikes)
So now that we have a local version of Drupal running and we have the latest development version, and we have Git the next thing that we need to get familiar with is drupal.org's issue queue. This is where the community talks about all of the work that is going on with drupal.org and drupal code. So if we want to get involved with the code we need to go where the conversation is. This lesson is going to walk you through the basics of what is the issue queue and how to use it. So we're going to go back to the ladder, and we're going to move ourselves up to the "Getting Started in the Issue Queue" lesson. And when we get here there's a lot of information but I want to start off by looking at the prerequisites up here at the top. and we're going to test an issue that we create, so there's a Drupal 8 sandbox that has a bug in it and if you click there you'll see that you can get to the Git clone command that you need to get a copy of that and then you need to set that up on your local web server which you've set up in previous lessons. So this is my Drupal ladder sandbox, which is from that particular sandbox there. So first you need to make sure you have that set up and ready to go. And I already have that done. And then what we're going to be doing is going through and talking a little bit about looking at the issue queue, what that means – and then we're going to create our own issue. You'll notice there's also this resource here which links to some documentation – just about how to actually issue – make an issue. So there's a lot of documentation for double-checking, and this video's just going to kind of run through the steps, with a little bit of background. I'm going to go to my dashboard and there's a bunch of queues over here. This is for Drupal core. So I'm just going to go into one of these just so we could look at what the issue queue looks like. Get a little orientation here. So when you go into an issue queue with the search options, you'll see we have things like 'Status' – so the open ones are needing work and review... there's also a variety of closed statuses, so this is sort of, you know, where is this thing right now? 'Priority'? - 'Critical', 'Major', 'Normal', or 'Minor'... So how important is the issue in terms of getting it done. The 'Category'... so 'Bug Report', 'Task', 'Feature Support' – these are all in every issue, regardless of the project. There's a version number... so that you make sure that your logging against the right version number. Components with core - all of the different core components - are there, but each project can define its own components, so in contrib you'll find quite a different component list. Then we also have issue tags – so you can also sort by a particular tag on an issue – and so like novice is a particular one which is handy to have so you can just restrict everything to 'Novice'. So let's move down and actually look at some issues here. And you'll notice that we have some columns that are going on... there's the title of it, status, The status is also indicated by the colors, so you'll see top one is active which is gray. 'Needs Review' is yellow. 'Needs work' is pink. 'Reviewed and tested by the community' is green. So you have this overview that gives you some basic information about what's going on with the issue at the time. Getting familiar with what these different terms are and how they're used is a key part to learning how to really use the issue queue. And as I said, there's a lot of documentation about this, and just going in and using the queues, you'll get very familiar with what various things are meaning here. So let's go back to our lesson here. And we're going to come down and look at what we're going to actually walk through. We're going to create an issue and then we're going to leave a comment and update the summary on it. And so to start things off, we need to go create an issue. So we're going to create an issue in the sandbox project, which has been specifically created for these lessons here. And so we go in here and you can see here's an issue queue that I've gotten to from a direct link. But I want to show you how you can get to that from a project page as well, so I'm going to go to the actual project page, like a module or a theme – this is just a sandbox but it's still a project. And in the sidebar there's issues – and if you click on the Advanced Search, I recommend that search before you create issues every time. So you can do filtering and search for keywords this way. So anytime you're on a project page – right sidebar – you can go into the issue queue from there. And then at the top you'll see there's this link for creating a new issue. So that's what we're going to do. And notice there's some documentation and notices at the top here linking off to how to report an issue using templates. You'll also notice that there is a notice that security issues should not be reported here because this is very public and we like to keep security issues private until they've been corrected. So just keep that in mind. So let's go down and look at the actual form here itself. The project name is already filled in for us because it knew where we came from. And what we need to do is fill out this information. So I'm going to do 'Miscellaneous', I'm gonna do 'Bug Report', and I'm gonna copy and paste this text for the title. So let's go back to my issue now that I have that copied. So 'Component' = 'Miscellaneous'. You can see the various components I said are quite different then they are in core, normally. But 'Miscellaneous' is what we're doing here. I'm gonna do a 'Bug Report', not a 'Feature Request'. And then I'll put in my request. And then I'll put in my title. And I'm going to leave the other things at their defaults because those are fine as a normal, active issue right now. And then I need to do my description and I'm going to go back to my lesson here and just copy and paste this as well. So we'll take that text, copy that, come back, paste over my... You'll notice that - so this is written out with a little explanation and it shows the current situation has this code tag for formatting. You can also use the little editor here, the html helper that we have here to format code. You'll see what this looks like once we submit this issue. Just to make it sort of stand out and that this is what's in the page. And then there's also a proposal for a solution. And we'll go down and just Save the issue. So we just gave it title, we gave it a description, we explained what was going on and then we'll just go ahead and save the issue. So that's creating a new issue, it's now in the issue queue and you can see that we have the title, and we have the - all the things that we selected are sort of in a box at the top. And then we have our description is in the Issue Summary. And you can see how the code tag made that text stand out. So now that we have the issue created, let's go back to our lesson instructions here And what it wants us to do now is actually confirm the bug and leave a comment. Which is why we got the sandbox site setup that has the bug in it so that we can go find it. So I'm going to go back to my sandbox and this is some text that's at the node add star whatever. So this when you add content. This is adding a new node. So I'm going to go to 'Add Content' and I'll just click 'Article'. Doesn't matter which one I pick. And you can see in the URL this is node add something. But they didn't have the instructions for the steps to get there without just typing it into the URL. So if I scroll down to the bottom here, then I can click on the URL path settings and this is where I can type in the URL alias and this is where the instructions are. Now, I'm going to take a screenshot of this. I use an application called Skitch. So I took a screenshot because I've found it, and I've seen it. Make it a little smaller here... And I'll just grab a box to kind of highlight it. You can use whatever screenshot thing if you want, if you have one. If you don't that's ok but it's a really really handy thing to use with issues, so people can see what you're talking about. So I'm going to just go ahead and put this on my desktop so that I can use that later. And now what I want to do is actually leave a comment. So I've gone through and I've seen what they're talking about. Although I think I could probably improve a little bit. So I'm going to go down here underneath the issue and leave a comment. And you notice I can change any of the settings on here, so you can change them but you should obviously only change them if it's a meaningful change. I don't need to change any of the statuses here. I just want to leave my comment. So I'm going to basically put some text in here that just says: "Yep, I gotcha, that makes sense." And I also want to just add those further instructions because it might make it easier for other people to find it. So the other thing I want to do here is add that screenshot that I took. And so if we go down here to the file attachments, I can find the image that I took and go ahead and attach that. And you'll notice it's listed here - so it's going to be part of the issue if I just saved it right now. So I can just go ahead and say 'See screenshot below...' or 'attached...' or something like that. I can also if I want to just actually embed that image in so that people can just see it without having to click on a link. So if I click on the little image thing in the editor here, I need to get the URL, so you can see the URL is right underneath here so I'll just copy that and paste that into the image URL. If I say OK it's going to force me to do alternative text as well so I need to just quickly describe what the image is. And now it inserts the HTML that's required to display that. So now I can go ahead and save. And here's my comment. And you can see the text and you can see the screenshot that's been embedded in the issue and people can actually click on the attachment as well if they would like to see the image that way. So the last thing we're going to do is actually update the summary, the issue summary on the issue. Let's go back to our lesson so we can see what it is that we need to be doing there. In the text here you see there's a link here to this issue summary template which is really handy and it's sort of one of those standards and you should get familiar with it and used to using it. So here's the actual template itself - there's a lot of explanation for what the different sections are underneath on this page so you could read up that. But I'm just going to copy and paste that sort of template that was there. And I'm going to come back - and I don't want to leave a comment - I left a comment but what I want to actually do is update the issue summary itself using the edit tab on the issue node itself. Because I want to update it and want to make the actual issue summary at the top clear to everybody who comes to the new issue. So that we can improve it and make it easier for people to find out what's going on and work on it. Now the first thing I want to do is paste the template in above the original issue. Because the last line is the original report. So I want the original report to stay there at the bottom and then I want to make sure that I put the person's name who did the original issue because I'm modifying the original issue now. And we want to retain that original issue that was reported. So once I've done that and I have that part of it done, I need to go through each of the lines here and update the text that's on there. So I'm just going to paste some text in here so you don't have to watch me type. And then I can just save that. Now when I do that you'll notice I'm editing the actual node and I'm getting that I'm required to actually leave a revision log message on this. So I'll go ahead and just leave that real quickly - if you have something specific like I'm updating blah blah blah about it you should put that in there. And now when I save it, everything works fine. And you'll see that the new summary that I added is now the top part of the issue so people can get up to speed very quickly and see what's going on. All of the comments are still there below. But this is a great way to help out in the issue queue, to keep things moving along for people. So that's a brief introduction to the issue queue. You should go in and start working in it and playing in it and get really familiar with it because this is the main tool that our community uses.

Video Details

Duration: 13 minutes and 11 seconds
Country: United States
Language: English
License: All rights reserved
Genre: None
Views: 31
Posted by: drupalizeme on Jul 18, 2012

In this step we turn our attention to Drupal.org and the community issue queue. This is where all of the active work for Drupal core takes place. We will look at the queue and create our issue to see how it works. This video follows the instructions for the Getting started in the issue queue lesson on learndrupal.org.

Caption and Translate

    Sign In/Register for Dotsub to translate this video.