DoES Liverpool relies on active participation from the community - if you see something that needs doing, just do it. If it's something you are currently unable to do, create a ticket to see if someone else can do it, but follow these guidelines for great justice...
Issues are more likely to get resolved if they are:
- Specific – what specifically needs to be done, and why?
- Measurable – how do we track progress or confirm success?
- Achievable – it has to be something achievable; otherwise, find a workaround
- Responsible – who is going to do it, or what skills are required?
- Timescale – when do we need to do it, how important is it?
More infos: Wikipedia
Issues can be either open or closed. Newly created issues are automatically "open", resolved issues are (should be!) "closed".
If you're new to GitHub or issue tracking in general, you can learn more here.
Any issue that seems to be abandonned will eventually be marked as "stale" - and then the clock starts ticking; if no further action is taken within ~1 month, the issue will be closed as Won't Do
.
If you want to "un-stale" an issue:
- Remove the
Stale
label - Add a comment stating why the issue should remain open.
- Make sure the issue is S.M.A.R.T.
Issues are labeled to help organise them.
You can add labels from the link in the sidebar on issue detail screens, and you can also see a list of all labels here (clicking one shows all open issues with that label).
Tip: When adding/removing labels from the issue detail screen, there's a search box at top of the label list that helps find specific labels. For example, if you're issue is something to do with a room, type "room" and it will filter the list to labels that contain the word "Room". Or type "do" to to filter to the main priority labels, etc.
We have several flavours of label to choose from...
Priority
Priority labels are loosely-based on the MoSCoW Method and start with a number denoting the priority. There should be only one of these labels per issue:
- 0 - Triage - requires review by DoES team
- 1 - Must DoES - mission critical issues
- 2 - Should DoES - important tasks
- 3 - Could DoES - "nice to have" stuff
- 4 - Stale - issue will be closed soon if no futher action
- 5 - Won't DoES - things we decided not to do
You can view prioritised issues on our kanban board: Huboard.
The priority labels must use a specific naming convention for that to work.
Location
Add location labels when an issue relates to a specific part of the building or a room.
Building:
- Building - anything not convered by any of the following labels in this section
- Building: Parking
Rooms:
TODO: Floorplan image (draft here)
- Room: Dinky
- Room: Fridge
- Room: Hotdesks (main room)
- Room: Kitchen
- Room: Recycling
- Room: Room29 (permadesks)
- Room: Workshop
Tools
Before using the tool labels (see later), there are some other labels that can be used in conjunction with them:
- Broken - if this label is associated with a tool label, the tool will show as Broken on the Status page.
- Maintenance - indicates routine, non-critical maintenance of the tool
- Bug - indicates ad-hoc / transient maintenance required for the tool (but won't mark the tool as Broken on the Status page)
These labels actually refer to machines (big tools), but "tools" takes up less screen space (: We name most equipment, the names are shown in brackets (eg. "Gerald" is the big laser cutter, "Sophia" is the small laser cutter).
TODO: Add links to wiki & detail status view links
- Tool: 3D Printer - RepRap - links: status
- Tool: 3D Printer - Ultimaker Extended - links: status, web
- Tool: 3D Printer - Ultimaker 2 - links: web
- Tool: 3D Printer - UP3 (Rose) - links: status
- Tool: 3D Printer - UP3 (Violet) - links: status
- Tool: 3D Printer - Other - any not listed above
- Tool: Bandsaw - links: status
- Tool: CNC Mill - Proxxon
- Tool: Dinky
- Tool: Laser Cutter - Large (Gerald) - links: status
- Tool: Laser Cutter - Small (Sophia) - links: status
- Tool: Polargraph (Tosca) - links: wiki, code
- Tool: Solder Station (Electronics Workbench)
- Tool: Vac-Former (Victor) - links: status
- Tool: Vinyl Cutter & Plotter (Roland Rat)
Note: If any of the tool labels are deleted, renamed or new ones added, you will need to update the Status page config.json
file to reflect those changes.
Systems
The following labels relate to various systems used by DoES:
- System: Doorbots - links: status 1, status 2, status 3, doorbot code, logging code
- System: Issue Tracker - links: web
- System: Network
- System: Status Page - links: web, code
- System: Website - links: web, status
- System: Wiki - links: web