This repository should be reviewed weekly or bi-weekly to keep everyone on the same page of development process.
This is set of documents about development process.
As the project goes on, we will add more documents here to standardize our development process. All documents should follow the styel of this one:
- There is a level 1 title as the docuent title with an optioinal description of the document.
- All major sections start from level 2 titles. This document is an example of suggested style.
The development_process.md is an overview document describing how we go through the requriement analysis, design, coding, testing, releasing and deployment phases.
The git_workflow.md describes a light-weight GitHub workflow for a small team.
The deploy.md describes the steps of deployment.
The review_guides folder contains guides for document review and code review.
This devops/ folder contains documents about DevOps
The backend folder contains documents for backend development. It include the following content:
- Start Java Project: the steps to create a new Java project.
- Java Style: show the style we use for our code. And give a short description about it.
- Logging: a guide of Java Logging.
- Build Scripts: scripts used in build process.
- Publish Process: publish code to github, build and test it.
The frontend folder contains documents for frontend development.
The ./frontend/vue_project_guide.md describes detail steps of creating and architecture of a new vue project.