[teamai] Push 87 resource(s) from XingfenD
This commit is contained in:
@@ -0,0 +1,36 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
|
||||
- Arabic translation (#21).
|
||||
|
||||
### Changed
|
||||
|
||||
- Improve French translation (#42).
|
||||
|
||||
### Deprecated
|
||||
|
||||
### Removed
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fix missing logo in home page
|
||||
|
||||
### Security
|
||||
|
||||
### Other (dependencies, CI, tools...)
|
||||
|
||||
## [1.0.0] - YYYY-MM-DD
|
||||
|
||||
### Added
|
||||
|
||||
- Initial release
|
||||
|
||||
[Unreleased]: https://github.com/{owner}/{repo}/compare/v1.0.0...HEAD
|
||||
[1.0.0]: https://github.com/{owner}/{repo}/releases/tag/v1.0.0
|
||||
@@ -0,0 +1,55 @@
|
||||
# Contributing to {project-name}
|
||||
|
||||
Thank you for your interest in contributing!
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Go {version} or later
|
||||
- Make (optional but recommended)
|
||||
- Docker (for integration tests only)
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/{owner}/{repo}.git
|
||||
cd {repo}
|
||||
|
||||
# Build
|
||||
go build -o myapp ./cmd/main.go
|
||||
|
||||
# Run unit tests
|
||||
go test -race ./...
|
||||
|
||||
# Run integration tests
|
||||
go test -race -tags=integration -timeout=300s ./...
|
||||
|
||||
# Run linter
|
||||
golangci-lint run --fix ./...
|
||||
```
|
||||
|
||||
## Development Workflow
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch: `git checkout -b feat/my-feature`
|
||||
3. Make your changes
|
||||
4. Add tests for new functionality
|
||||
5. Run `go test ./...` and `golangci-lint run`
|
||||
6. Commit with a descriptive message
|
||||
7. Push and open a Pull Request
|
||||
|
||||
## Code Guidelines
|
||||
|
||||
- Follow [Effective Go](https://go.dev/doc/effective_go)
|
||||
- Add doc comments to all exported symbols
|
||||
- Write table-driven tests
|
||||
- Keep test coverage above {X}%
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
Use [GitHub Issues](https://github.com/{owner}/{repo}/issues). Include:
|
||||
|
||||
- Go version (`go version`)
|
||||
- OS and architecture
|
||||
- Steps to reproduce
|
||||
- Expected vs actual behavior
|
||||
@@ -0,0 +1,118 @@
|
||||
# {project-name}
|
||||
|
||||
<!-- Replace {owner} and {repo} throughout this file -->
|
||||
|
||||
[](https://go.dev/) [](./LICENSE) [](https://github.com/{owner}/{repo}/actions) [](https://codecov.io/gh/{owner}/{repo}) [](https://goreportcard.com/report/github.com/{owner}/{repo}) [](https://pkg.go.dev/github.com/{owner}/{repo})
|
||||
|
||||
<!-- Additional badges (pick what's relevant):
|
||||
[](https://github.com/{owner}/{repo}/releases)
|
||||
[](https://github.com/{owner}/{repo}/releases)
|
||||
[](https://hub.docker.com/r/{owner}/{repo})
|
||||
-->
|
||||
|
||||
<!-- 1-2 sentences: what does this project do and who is it for? -->
|
||||
|
||||
<!-- Show the project in action: code snippet, GIF, screenshot, or video.
|
||||
For libraries: show a minimal working code example.
|
||||
For CLIs/tools: a GIF or screenshot is often more effective. -->
|
||||
|
||||
```go
|
||||
// Minimal working example showing the most common use case
|
||||
```
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
<!-- For libraries: -->
|
||||
|
||||
```bash
|
||||
go get github.com/{owner}/{repo}
|
||||
```
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import "github.com/{owner}/{repo}"
|
||||
|
||||
func main() {
|
||||
// Minimal working example
|
||||
}
|
||||
```
|
||||
|
||||
<!-- For applications, uncomment and use this instead:
|
||||
|
||||
### Pre-built binaries
|
||||
|
||||
Download from [GitHub Releases](https://github.com/{owner}/{repo}/releases/latest).
|
||||
|
||||
| Platform | Architecture | Download |
|
||||
| -------- | ------------ | ----------------------------------------------------------------------------------------------- |
|
||||
| Linux | amd64 | [Download](https://github.com/{owner}/{repo}/releases/latest/download/{repo}-linux-amd64) |
|
||||
| Linux | arm64 | [Download](https://github.com/{owner}/{repo}/releases/latest/download/{repo}-linux-arm64) |
|
||||
| macOS | amd64 | [Download](https://github.com/{owner}/{repo}/releases/latest/download/{repo}-darwin-amd64) |
|
||||
| macOS | arm64 | [Download](https://github.com/{owner}/{repo}/releases/latest/download/{repo}-darwin-arm64) |
|
||||
| Windows | amd64 | [Download](https://github.com/{owner}/{repo}/releases/latest/download/{repo}-windows-amd64.exe) |
|
||||
|
||||
### From source
|
||||
|
||||
```bash
|
||||
go install github.com/{owner}/{repo}@latest
|
||||
```
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
docker pull {registry}/{owner}/{repo}:latest
|
||||
docker run --rm {registry}/{owner}/{repo}:latest --help
|
||||
```
|
||||
|
||||
### Homebrew (macOS)
|
||||
|
||||
```bash
|
||||
brew install {owner}/{repo}
|
||||
```
|
||||
|
||||
### APT (debian/ubuntu)
|
||||
|
||||
```bash
|
||||
apt install {package}
|
||||
```
|
||||
|
||||
-->
|
||||
|
||||
## ✨ Features
|
||||
|
||||
<!-- Very detailed feature descriptions, organized by area.
|
||||
This is the longest section of the README.
|
||||
Use headings, tables, and code examples generously. -->
|
||||
|
||||
### Feature Area 1
|
||||
|
||||
<!-- Description with code examples -->
|
||||
|
||||
### Feature Area 2
|
||||
|
||||
<!-- Description with code examples -->
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
Please read the [contributing guide](CONTRIBUTING.md) before submitting a PR.
|
||||
|
||||
<!-- Or if the contributing guide is very short:
|
||||
|
||||
```bash
|
||||
# Build
|
||||
go build -o myapp ./cmd/main.go
|
||||
|
||||
# Run unit tests
|
||||
go test -race ./...
|
||||
|
||||
# Run integration tests
|
||||
go test -race -tags=integration -timeout=300s ./...
|
||||
|
||||
# Run linter
|
||||
golangci-lint run --fix ./...
|
||||
-->
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
@@ -0,0 +1,67 @@
|
||||
# {project-name}
|
||||
|
||||
> {One-line description of the project}
|
||||
|
||||
## Overview
|
||||
|
||||
{2-3 sentences explaining what this project does, what problem it solves, and who it's for.}
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
go get github.com/{owner}/{repo}
|
||||
```
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import "github.com/{owner}/{repo}"
|
||||
|
||||
func main() {
|
||||
// Minimal working example
|
||||
}
|
||||
```
|
||||
|
||||
## Key Concepts
|
||||
|
||||
- **{Concept 1}**: {Brief explanation}
|
||||
- **{Concept 2}**: {Brief explanation}
|
||||
- **{Concept 3}**: {Brief explanation}
|
||||
|
||||
## API Reference
|
||||
|
||||
### Core Functions
|
||||
|
||||
- `FuncName(params) returns` - {What it does and when to use it}
|
||||
- `AnotherFunc(params) returns` - {What it does and when to use it}
|
||||
|
||||
### Core Types
|
||||
|
||||
- `TypeName` - {What it represents}
|
||||
- `AnotherType` - {What it represents}
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### {Pattern 1 Name}
|
||||
|
||||
```go
|
||||
// Example code showing this pattern
|
||||
```
|
||||
|
||||
### {Pattern 2 Name}
|
||||
|
||||
```go
|
||||
// Example code showing this pattern
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
|
||||
- `ErrName` - {When this error occurs and how to handle it}
|
||||
- `ErrAnother` - {When this error occurs and how to handle it}
|
||||
|
||||
## References
|
||||
|
||||
- Documentation: {URL}
|
||||
- Repository: https://github.com/{owner}/{repo}
|
||||
- Go Reference: https://pkg.go.dev/github.com/{owner}/{repo}
|
||||
- Issues: https://github.com/{owner}/{repo}/issues
|
||||
Reference in New Issue
Block a user