Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] The repository structure and workflow #1

Open
hien-p opened this issue Oct 23, 2024 · 5 comments
Open

[DOCS] The repository structure and workflow #1

hien-p opened this issue Oct 23, 2024 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@hien-p
Copy link
Member

hien-p commented Oct 23, 2024

Tên repo có prefix:

Ví dụ: Movelazy- extension , Movelazy-web, Movelazy-sui-development...

Branching Strategy

Mỗi repo có 3 branch default:

  • main cho production
  • staging cho test
  • dev cho develop

Workflow Rules

  • member làm việc thì tạo branch mới và commit lên git rồi tạo PR
  • Không cho commit trực tiếp từ local lên 3 nhánh trên
  • **main được merge từ staging vào thông qua PR
  • Staging đc merge từ dev thông qua PR, và dev được merge từ PR tính năng vào

Code Review and Merging

Mỗi project chỉ có 1 vài members được quyền merge code từ PR và tốt nhất nên có review trước khi merge code

Commit Messages

Commit message nên có git convention follow: https://www.conventionalcommits.org/en/v1.0.0/
Các từ đơn giản như fix, feat, chore..

Không add bất kì key nào của production vào trong source code. Nếu muốn để tên env name thì set một lệnh .env.sample

@hien-p hien-p added the documentation Improvements or additions to documentation label Oct 23, 2024
@hien-p hien-p added this to the v0.0.1 milestone Oct 23, 2024
@hien-p
Copy link
Member Author

hien-p commented Oct 23, 2024

cc: @phapdev

Pháp gửi cho mình cái link youtube với notion link về gitflow mà từng làm ở weminal sharing buổi 1 nha

@Menh1505
Copy link
Contributor

cc: @Huc06 @Khoa-Dam
we will clone the structure of this project Remix-project but not for browers, It's for VSCode

Menh1505 added a commit that referenced this issue Oct 24, 2024
merge fea/webview-update
@hien-p
Copy link
Member Author

hien-p commented Oct 24, 2024

Create một branch mới nhé có thể set name là feature/vscode-integration hoặc vscode-remix-clone tuỳ mấy đứa

cc: @Menh1505

@Menh1505
Copy link
Contributor

Menh1505 commented Oct 24, 2024

cc: @Huc06 @Khoa-Dam
Clean code bên frontend để tui nhảy vào làm nữa.

  • Chia files đúng các folder
    • Chia components cho Foundry
    • Chia components cho Aptos
  • Tạo pages tương ứng các frames trong figma sau đó gọi lại components vào page
  • Băm nhỏ các file jsx (file .jsx làm nhiệm vụ chính là return html, các hàm xử lý dài dòng nên cắt sang file .js rồi gọi ngược lại)
  • Những hàm có chung tính năng hay nhiều hàm có chung mục đích xử lý vấn đề nào đó thì gộp nó lại thành một file. Ví dụ button.js chứa toàn bộ hàm xử lý sự kiện button.

@Weminal-labs Weminal-labs deleted a comment from Huc06 Oct 24, 2024
@Khoa-Dam
Copy link
Contributor

Khoa-Dam commented Oct 24, 2024

[DOCS] FE
Route chính để chuyển 2 trang chính là aptos và sol

  • Có thể tạo nested routes để chia các route con tương ứng với từng thành phần, như foundry có sub pages là account và deploy thì đưa 2 routes này vào page foundry

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants