Skip to content
SamanthaCra edited this page May 2, 2024 · 7 revisions

Rainy Arcades Studio 5/6 GitHub Guidelines.

Issues

Make sure issues have a clear title, a good description and have been added to the project board.
image

Link a milestone (user story) if there is one (Try to think of one if there isn't already one!).
image

Make sure completed issues are closed with relevant comments and evidence. This includes if the issue is no longer going to be worked on.
image

Link code and pull requests to open issues so it is easy to keep track of them.
image

Milestones (User stories)

We are using the milestones features to write user stories. The description can elaborate on the intention of the user story and have who wrote it as there are no indicators otherwise. There are a lot of issues that have been moved over there. image

Wiki

Wiki is used for documentation and research. There should be clear titles and proper formatting used. Anyone should be able to look at a title and not be surprised at what they are presented with. Please ask if you can add to a wiki page if you are not the original author. image

Project Board/Roadmap

Issues should be regularly kept up to date in the project board. image