Skip to content

Commit 6998714

Browse files
fainohubfainohub
committed
chore: update documentation
1 parent 3bf1f7d commit 6998714

File tree

7 files changed

+11145
-0
lines changed

7 files changed

+11145
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
---
6+
7+
**Description**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. ...
13+
2. ...
14+
3. ...
15+
16+
**Expected behavior**
17+
What you expected to happen.
18+
19+
**Logs/Stacktrace**
20+
Paste relevant logs or stack traces (remove any sensitive data).
21+
22+
**Environment**
23+
- PHP:
24+
- Hyperf:
25+
- Library version:
26+
- OS/Container:
27+
28+
**Additional context**
29+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
---
6+
7+
**Problem/Context**
8+
Describe the problem this feature would solve.
9+
10+
**Proposed solution**
11+
A clear and concise description of what you want to happen.
12+
13+
**Alternatives considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Impact**
17+
- [ ] Tracing
18+
- [ ] Metrics
19+
- [ ] Logs
20+
- [ ] Performance
21+
- [ ] Developer Experience
22+
23+
**Additional notes**
24+
Links, references, or examples if applicable.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Question
3+
about: Ask a question
4+
labels: question
5+
---
6+
7+
**Question**
8+
Write your question clearly.
9+
10+
**Context**
11+
Where are you integrating this library (HTTP, DB, Redis, SQS...)? Which version?
12+
13+
**Examples/References**
14+
Provide code snippets or links if relevant.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Description
2+
Explain what this PR does and why it is needed.
3+
4+
## Type of change
5+
- [ ] Bug fix
6+
- [ ] New feature
7+
- [ ] Documentation
8+
- [ ] Performance/Refactor
9+
- [ ] CI/CD/Chore
10+
11+
## Checklist
12+
- [ ] Title follows *Conventional Commits* (e.g., `feat: add SQS aspect`)
13+
- [ ] Tests added/updated
14+
- [ ] `composer test` passes locally
15+
- [ ] Documentation updated (README/Docs)
16+
- [ ] No breaking changes (or documented if any)
17+
18+
## Related issues
19+
Closes #<id>, Relates to #<id>

‎CONTRIBUTING.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Contributing
2+
3+
Thank you for considering contributing to `hyperf-opentelemetry`! 🎉
4+
5+
We welcome contributions of all kinds: bug fixes, new features, documentation improvements, tests, and discussions.
6+
7+
---
8+
9+
## Getting started
10+
11+
1. **Fork** the repository and create a new branch from `main`:
12+
```bash
13+
git checkout -b feat/your-feature-name
14+
```
15+
16+
2. Install dependencies and run tests:
17+
```bash
18+
composer install
19+
composer test
20+
```
21+
22+
3. Follow code style guidelines:
23+
- PHP: PSR-12
24+
- Strict typing when possible
25+
- Avoid creating unnecessary root spans; ensure proper context propagation
26+
27+
---
28+
29+
## Issues
30+
- Use labels: bug, enhancement, question, performance, docs, good first issue, help wanted.
31+
- When opening an issue, include:
32+
- Steps to reproduce
33+
- Current vs. expected behavior
34+
- Environment (PHP, Hyperf, OS, library version)
35+
- Relevant logs/stack traces
36+
37+
---
38+
39+
## Pull Requests
40+
41+
- Use Conventional Commits for PR titles (e.g., feat: add SQS aspect, fix: redis connection span leak).
42+
- Include tests whenever possible.
43+
- Update README/Docs if the change impacts usage or configuration.
44+
- Checklist before submitting:
45+
- [ ] All tests passing (composer test)
46+
- [ ] Code style/lint OK
47+
- [ ] Reasonable coverage for new code
48+
- [ ] Documentation updated if necessary
49+
- [ ] No breaking changes (or clearly documented)
50+
51+
---
52+
53+
## Branches & Releases
54+
55+
- main: stable branch
56+
- `feat/*`, `fix/*`, `chore/*`: development branches
57+
- Versioning follows Semantic Versioning (SemVer):
58+
- `MAJOR.MINOR.PATCH`
59+
- Releases include changelogs (see GitHub Releases)
60+
61+
---
62+
63+
## Communication
64+
65+
- Slack channel: #hyperf-opentelemetry
66+
- Technical discussions: GitHub Issues or Discussions

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ This library enables instrumentation of Hyperf-based applications for exporting
2727
composer require opencodeco/hyperf-opentelemetry
2828
```
2929

30+
---
31+
3032
## ⚙️ Configuration
3133
1. Publish the configuration file
3234
```shell
@@ -64,6 +66,8 @@ return [
6466
];
6567
```
6668

69+
---
70+
6771
## 👨‍💻 Development
6872
Build the image
6973
```shell
@@ -79,3 +83,8 @@ Run tests
7983
```shell
8084
make test
8185
```
86+
87+
---
88+
89+
## 🤝 Contributing
90+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)