-
Notifications
You must be signed in to change notification settings - Fork 5
How to work on jira tickets #4
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
Conversation
FWIW, this is already on the wiki: https://wiki.musicbrainz.org/How_to_Report_an_Issue |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, FWIW.
|
||
### Working on tickets | ||
|
||
If you want to work on a ticket, you don't need to ask for permission. Just check |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe it'd be good to mention that if something is marked "Decision Required," they should resolve any open questions first. I think this status is specific to our workflow.
Jira.md
Outdated
|
||
When you finish the task, open a Pull request on the relavent project. See [GitHub.md] with | ||
additional information about how to name and submit a Pull Request. In Jira, click `Resolve Issue` | ||
to mark that a review has been submitted, and paste a link to the GitHub pull request URL as |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed there are three different capitalizations of "pull request" here. :)
Pull request
Pull Request
pull request
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, I assume ticket and bug refer to the same thing. We should settle on one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like ticket, because it's broader (task, improvement, etc)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree.
`Start Progress`. This shows others that you are actively working on a task. | ||
|
||
When you finish the task, open a Pull request on the relavent project. See [GitHub.md] with | ||
additional information about how to name and submit a Pull Request. In Jira, click `Resolve Issue` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In MBS at least, they have to click "In Code Review." I guess it's different for other projects.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some projects have the same workflow set on them. Perhaps we should make it a default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the workflow for AB and LB is the same, but I'm not sure about the others. Obviously MBS is different. Can someone provide us with a list of what project has which, and what the steps are? @Freso? I don't know if this is something that can only be seen by an admin or by everyone.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
well. at least there's only 2... Do we need to bring this up at a meeting? I note that there are only 2 webapp projects on default. i wonder if they're just on default because no one changed them.
Can you post an image or text description of the MusicBrainz workflow? (from the MBS equivalent of https://tickets.metabrainz.org/plugins/servlet/project-config/AB/workflows).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps this page can be generalised to apply to all projects and maybe even moved there?
Or maybe even Ticket_tracking.md? |
Jira.md
Outdated
@@ -0,0 +1,29 @@ | |||
# MetaBrainz bug tracking | |||
|
|||
MetaBrainz uses Jira to track bugs. It is hosted at https://tickets.metabrainz.org/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.
Jira.md
Outdated
|
||
MetaBrainz uses Jira to track bugs. It is hosted at https://tickets.metabrainz.org/ | ||
|
||
Each main MetaBrainz project has its own project in Jira. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe also link to https://tickets.metabrainz.org/secure/BrowseProjects.jspa.
Jira.md
Outdated
|
||
Each main MetaBrainz project has its own project in Jira. | ||
|
||
### Working on tickets |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be ## Working on tickets
?
`Start Progress`. This shows others that you are actively working on a task. | ||
|
||
When you finish the task, open a Pull request on the relavent project. See [GitHub.md] with | ||
additional information about how to name and submit a Pull Request. In Jira, click `Resolve Issue` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some projects have the same workflow set on them. Perhaps we should make it a default.
Jira.md
Outdated
to mark that a review has been submitted, and paste a link to the GitHub pull request URL as | ||
a comment. | ||
|
||
Once a review has been successfully merged, the project admin will close the ticket. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would probably more correct to say it like this:
Once a pull request has been reviewed and merged by one of the project maintainers, it can be closed and marked as "Fixed".
Jira.md
Outdated
|
||
When you finish the task, open a Pull request on the relavent project. See [GitHub.md] with | ||
additional information about how to name and submit a Pull Request. In Jira, click `Resolve Issue` | ||
to mark that a review has been submitted, and paste a link to the GitHub pull request URL as |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, I assume ticket and bug refer to the same thing. We should settle on one.
Jira.md
Outdated
they are still going to complete the work. | ||
|
||
If you have any questions about a ticket, add a comment. Project leads will automatically | ||
get sent an email informing them of your comment, so you don't need to follow it up |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Project leads will automatically get sent an email informing them of your comment
Not necessarily. People might not receive an email depending on how their notifications are configured. For example, I don't receive emails about every CB ticket. I do receive email if something happens to tickets that I'm watching or ones that I opened.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My reason for this is that I want to stop people from telling me on IRC "hey I did something, can you look". If this isn't global we should do something else. Perhaps just saying this is good enough?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Saying something like "People who are watching this ticket will automatically..." will be more correct I think.
Jira.md
Outdated
get sent an email informing them of your comment, so you don't need to follow it up | ||
yourself. | ||
|
||
When you have assigned a ticket to yourself, set its status to in progress by clicking |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"In progress"
?
Covered all points except the workflow stuff. |
Do we keep it |
This is a continuation of discussion on #4: #4 (comment).
I thought about that - if we consider that contributing guidelines are for people who want to help develop our apps then jira is the tool that they need to interact with for this task. I don't mind keeping it jira. |
Alright. |
Some rough text on how to work on jira tickets. Mostly intended to try and stop the "can I work on this?" comments that we're getting.
Does it make sense to call this Jira.md or does it fall into the wider Bugs.md
Do we also want "how to report bugs", or is that more suited to the wiki?
I wrote the workflow text based on the workflow that we have in AB. I don't know if this is the same in other projects. I seem to recall that they all use the same workflow, so I hope it's ok. If not, please propose prose that better suits what we do/try to do.
Do we want so much text, would a pretty diagram also be useful?