Skip to content

Latest commit

 

History

History
92 lines (83 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

92 lines (83 loc) · 2.89 KB
Raw

🧐 Contributing

Index

✍ Report

When reporting bugs or developing a function, instead of creating a PR, it is better to create a issue first.

Error Report

Please fill out the template including the environment, bug description, expected behavior, and screenshots.

  • Environment(*): Android, iOS, Web
  • Bug Description*): Description of the bug
  • Expected behavior: Write about how it will work if it works normally
  • Use the Issues Tab

Feature Develop

Prior to creating a function, it is crucial to engage in a preliminary discussion regarding the specific function that needs to be developed.

  • An existing problem(*): Motivation and problem awareness for function development
  • Desired Solution(*): Write about the expected outcome
  • Screenshots: Related screenshots or videos
  • Use the Issues Tab

API request

If there is an API needed for development, please request it using the template of Issue Tab.

  • Name of API(*): Write down the name of the API you want to request.
  • Name of Page(*): Write down the name of the page or the file name that requires the API.
  • Type of API(*): Select what the API does.
  • Request(*): Write down in detail what functions the API should perform.
  • Result(*): Write down the information that the API should contain. (JSON)
  • Other: Ask any other questions.
  • Use the Issues Tab

Discussion (Q&A during development)

If you are facing difficulties in developing or have any questions, feel free to ask for assistance.

🛠 Project setup

yarn install

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

📁 Project Structure

📦src  
 ┣ 📂assets  
 ┃ ┣ 📂css  
 ┃ ┣ 📂i18n  
 ┃ ┃ ┣ 📂lang  
 ┃ ┣ 📂images
 ┃ ┗ 📂js  
 ┃ ┃ ┣ 📂login  
 ┣ 📂components  
 ┃ ┣ 📂button  
 ┃ ┣ 📂layout  
 ┃ ┣ 📂pageComponents  
 ┃ ┃ ┣ 📂board  
 ┃ ┃ ┣ 📂channel  
 ┃ ┃ ┣ 📂fileBox  
 ┃ ┃ ┣ 📂intro  
 ┃ ┃ ┣ 📂main  
 ┃ ┃ ┣ 📂myPage  
 ┃ ┃ ┗ 📂search  
 ┃ ┣ 📂popup  
 ┃ ┗ 📂unit  
 ┣ 📂pages  
 ┃ ┣ 📂intro  
 ┃ ┗ 📂routerPages  
 ┣ 📂router
 ┣ 📂store  
 ┗ ┗ 📂modules

✨ Tutorials

This is a tutorial for developers who are new to University.
⭐ Go tutorial page

🧑‍💻 Guide

This is a guide for developers.
⭐ Go guide page