At Github, we want to start new projects faster using best practices with a predefined structure and focusing on core ideas implementation rather than wasting time on environment configuration and copying boilerplate code.
I defined a spec template that I could use to quickly start building a full-fledged project.
In each directory, there is a README.md and an OWNERS, which explains what the directory does and who owns it.
Labels denger: Read about the go-project-layout tag design
Note: You can get started quickly with go-project-layout.
- Generate a new repository from the template.
- Clone the repository locally.
- Update files, read the README files in each directory.
- Write your code and tests.
Work with Makefile
โฏ make help # show help
โฏ make build # build binaryWork with actions
Actions provide handling of PR and issue.
We used the bot ๐@kubbot, It can detect issues in Chinese and translate them to English, and you can interact with it using the command /comment.
Comment in an issue:
โฏ /intiveWork with Tools
โฏ make toolsWork with Docker
โฏ make deploygraph LR
subgraph External Services
feishuAPI --> sheetParser
end
subgraph Sheet Parser & Manager
sheetParser[Sheet Parser] --> versionControl
versionControl[Version Control] --> sheetDisplay
end
subgraph Display
sheetDisplay[Sheet Display] --> UI
end
subgraph Backend
versionControl --> API
end
subgraph Frontend
UI[User Interface]
end
API --> UI
UI --> feishuAPI
MVC Architecture Design:
graph LR
A[View] -->|1. User interaction| B(Controller)
B -->|2. Requests data| C(Model)
C -->|3. Returns data| B
B -->|4. Updates view| A
Catalog standardization design structure:
.go-project-layout
โโโ CONTRIBUTING.md # Contribution guidelines
โโโ LICENSE # License information
โโโ Makefile # Makefile for building and running the project
โโโ README.md # Project overview in English
โโโ README_zh-CN.md # Project overview in Chinese
โโโ api # API-related files
โ โโโ OWNERS # API owners
โ โโโ README.md # API documentation
โโโ assets # Static assets, such as images and stylesheets
โ โโโ README.md # Assets documentation
โโโ build # Build-related files
โ โโโ OWNERS # Build owners
โ โโโ README.md # Build documentation
โโโ cmd # Command-line tools and entry points
โ โโโ OWNERS # Command owners
โ โโโ README.md # Command documentation
โโโ configs # Configuration files
โ โโโ OWNERS # Configuration owners
โ โโโ README.md # Configuration documentation
โ โโโ config.yaml # Main configuration file
โโโ deploy # Deployment-related files
โ โโโ OWNERS # Deployment owners
โ โโโ README.md # Deployment documentation
โโโ docs # Project documentation
โ โโโ OWNERS # Documentation owners
โ โโโ README.md # Documentation index
โโโ examples # Example code and usage
โ โโโ OWNERS # Example owners
โ โโโ README.md # Example documentation
โโโ init # Initialization files
โ โโโ OWNERS # Initialization owners
โ โโโ README.md # Initialization documentation
โโโ internal # Internal application code
โ โโโ OWNERS # Internal code owners
โ โโโ README.md # Internal code documentation
โ โโโ app # Application logic
โ โโโ pkg # Internal packages
โ โโโ utils # Utility functions and helpers
โโโ pkg # Public packages and libraries
โ โโโ OWNERS # Package owners
โ โโโ README.md # Package documentation
โ โโโ common # Common utilities and helpers
โ โโโ log # Log utilities
โ โโโ tools # Tooling and scripts
โ โโโ utils # General utility functions
โ โโโ version # Version information
โโโ scripts # Scripts for development and automation
โ โโโ LICENSE_TEMPLATES # License templates
โ โโโ OWNERS # Script owners
โ โโโ README.md # Script documentation
โ โโโ githooks # Git hooks for development
โ โโโ make-rules # Makefile rules and scripts
โโโ test # Test files and test-related utilities
โ โโโ OWNERS # Test owners
โ โโโ README.md # Test documentation
โโโ third_party # Third-party dependencies and libraries
โ โโโ README.md # Third-party documentation
โโโ tools # Tooling and utilities for development
โ โโโ README.md # Tool documentation
โโโ web # Web-related files, such as HTML and CSS
โโโ OWNERS # Web owners
โโโ README.md # Web documentationWe welcome everyone to join us and contribute to go-project-layout, whether you are new to open source or professional. We are committed to promoting an open source culture, so we offer community members neighborhood prizes and reward money in recognition of their contributions. We believe that by working together, we can build a strong community and make valuable open source tools and resources available to more people. So if you are interested in go-project-layout, please join our community and start contributing your ideas and skills!
We take notes of each biweekly meeting in GitHub discussions, and our minutes are written in Google Docs.
go-project-layout maintains a public roadmap. It gives a a high-level view of the main priorities for the project, the maturity of different features and projects, and how to influence the project direction.
kubecub Our goal is to build a top-level open source community. We have a set of standards, in the Community repository.
If you'd like to contribute to this go-project-layout repository, please read our contributor documentation.
Before you start, please make sure your changes are in demand. The best for that is to create a new discussion OR Slack Communication, or if you find an issue, report it first.
Sealer is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
