-
Notifications
You must be signed in to change notification settings - Fork 12
Guides and Things to Know
I eventually want to see this in a more general location such as a gh-page or a page of the website (maybe ministry team pages would be a cool idea?). But for now, it is going to live here.
Branching Guide - We use the gitflow workflow. A great quick guide on a single branch's flow can be found here
Using GitHub Issues - There are some pretty useful tricks in here.
Markdown Guide - This is super useful for creating issues, comments, or documentation on GitHub.
More GitHub Info - This has some of the above guides and a few other ones that you might find helpful, but this is more of an additional resource link.
Starting from the 1.5.0 release of the iOS app and Keystone server we will be using the semantic versioning convention. You can read more about semantic versioning here.
All of our projects have a set of standard set of Labels split into 3 categories. Below you will find the Labels and what they mean.
Blocker - Blocks development and/or testing work, production could not run.
Critical - Crashes, loss of data, severe memory leak.
Major - Major loss of function.
Minor - Minor loss of function, or other problem where easy workaround is present.
Trivial - Cosmetic problem like misspelled words or misaligned text.
Bug - A problem which impairs or prevents the functions of the product.
Improvement - An improvement or enhancement to an existing feature or task.
Story - A new feature of the product, which has yet to be developed. (For the Keystone project this is labeled as New Feature)
Task - A task that needs to be done.
Cannot Reproduce - All attempts at reproducing this issue failed, or not enough information was available to reproduce the issue. Reading the code produces no clues as to why this behavior would occur. If more information appears later, please reopen the issue.
Won't Fix - The problem described is an issue which will never be fixed. Most likely these will be issues that are caused by issues with tools we use or that we decide aren't worth the effort to fix.
API - For issues that are related to the API. Generally used for Endpoints not behaving as expected or requesting a new endpoint.
Front End - For issues relating to the website front end. This won't be applicable until we start the website migration.
Models - For issues relating to the Admin Panel and data models.
Include a detailed description of what you think should be implemented. Try to answer these questions:
What does it do?
How does it work?
Where should it be?
Why is this feature needed?
Who does this feature help?
Who should have access to this feature? (If applicable)
Include as much detail as possible about the error that occurred. Try to answer these questions:
What error did I receive?
What happened?
What did I expect to happen?
What are the steps to recreate the issue?
Did the error occur on the Website or from the App?
What device was I using when the error occurred? (If using to Website include Browser and Operating System. If using the App include Device Model, Operating System version, and App Version.)
Each App has a Project master list. All issues for that app should be linked to the master list. Beyond that, there may be App specific or organizational projects that issues should be assigned to.