-
Notifications
You must be signed in to change notification settings - Fork 33
Issues and milestones
Issues and milestones are our primary way to discuss and keep track of (concrete) things that need to be done. You can view our issue list here and our milestone list here.
An issue, also called a ticket, is a discussion thread with a few bells and whistles attached. There is a lot of liberty. Anyone with a GitHub account can file issues and reply to them. There is no firm restriction with regard to topics, but they should ultimately be about work on the project; issues may be started to report a bug, to ask for help, to suggest changes or new features, etcetera.
- Click on a tag to see only tickets with that tag. This could be useful if for example you are looking for bugs to fix or for something to test on your platform.
- Click on the Milestones tab and then on the title of a milestone to see all issues attached to the milestone. This way you can see what still needs to be done before the milestone is passed.
See also: Workflow.
Make the title as descriptive as reasonably possible. In the body, for as far as applicable, explain:
- what you want. What would you like to do or have that currently isn't possible, doesn't exist or doesn't work?
- what you have done. What steps did you take? What output did you get? What does your code do?
- what you need. Is it feedback, information, help, testing...?
- how others can offer what you need. What steps should they take? What do you want to know?
- what existing commits and issues are relevant. Link to commits by copying the first 10 or more digits of the hash (example: 6e40bf9a11). Link to issues by typing a hash and the issue number (example: #52). It is totally fine to link to closed issues.
If you created a ticket you can also close it. However, you should only do that when you find that your issue has been solved, or if you think that the ticket is no longer relevant.
- Try to be complete. Mention relevant commits and issues if they haven't been linked to before. Cover all parts of the issue that you are able to cover.
- Do not write overly long replies. If you find that you have a lot to say, start with the most urgent stuff and save the rest for later.
- Stay to the point. If you get an idea for something that should be done about the project while writing a reply, consider to put that idea in a new ticket.