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

bugfix: fix the correct name of opentelemetry repo #10

Merged
merged 1 commit into from
Nov 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/00-bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: "affected/package: "
Please answer these questions before submitting your issue. Thanks!
-->

### What version of trpc-go-opentelementry are you using?
### What version of trpc-go-opentelemetry are you using?


### Does this issue reproduce with the latest release?
Expand Down
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ English | [中文](CONTRIBUTING.zh_CN.md)

# How to Contribute

Thank you for your interest and support in tRPC-go-opentelementry!
Thank you for your interest and support in tRPC-go-opentelemetry!

We welcome and appreciate any form of contribution, including but not limited to submitting issues, providing improvement suggestions, improving documentation, fixing bugs, and adding features.
This document aims to provide you with a detailed contribution guide to help you better participate in the project.
Expand All @@ -12,11 +12,11 @@ We look forward to working with you to make this project better together!
## Before contributing code

The project welcomes code patches, but to make sure things are well coordinated you should discuss any significant change before starting the work.
It's recommended that you signal your intention to contribute in the issue tracker, either by claiming an [existing one](https://github.com/trpc-ecosystem/go-opentelementry/issues) or by [opening a new issue](https://github.com/trpc-ecosystem/go-opentelementry/issues/new).
It's recommended that you signal your intention to contribute in the issue tracker, either by claiming an [existing one](https://github.com/trpc-ecosystem/go-opentelemetry/issues) or by [opening a new issue](https://github.com/trpc-ecosystem/go-opentelemetry/issues/new).

### Checking the issue tracker

Whether you already know what contribution to make, or you are searching for an idea, the [issue tracker](https://github.com/trpc-ecosystem/go-opentelementry/issues) is always the first place to go.
Whether you already know what contribution to make, or you are searching for an idea, the [issue tracker](https://github.com/trpc-ecosystem/go-opentelemetry/issues) is always the first place to go.
Issues are triaged to categorize them and manage the workflow.

Most issues will be marked with one of the following workflow labels:
Expand All @@ -34,7 +34,7 @@ This process gives everyone a chance to validate the design, helps prevent dupli
It also checks that the design is sound before code is written; the code review tool is not the place for high-level discussions.

When opening an issue, make sure to answer these five questions:
1. What version of go-opentelementry are you using ?
1. What version of go-opentelemetry are you using ?
2. What operating system and processor architecture are you using(`go env`)?
3. What did you do?
4. What did you expect to see?
Expand All @@ -45,7 +45,7 @@ For change proposals, see Proposing Changes To [tRPC-Proposals](https://github.c
## Contributing code

Follow the [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) to [create a GitHub pull request](https://docs.github.com/en/get-started/quickstart/github-flow#create-a-pull-request).
If this is your first time submitting a PR to the go-opentelementry project, you will be reminded in the "Conversation" tab of the PR to sign and submit the [Contributor License Agreement](https://github.com/trpc-group/cla-database/blob/main/Tencent-Contributor-License-Agreement.md).
If this is your first time submitting a PR to the go-opentelemetry project, you will be reminded in the "Conversation" tab of the PR to sign and submit the [Contributor License Agreement](https://github.com/trpc-group/cla-database/blob/main/Tencent-Contributor-License-Agreement.md).
Only when you have signed the Contributor License Agreement, your submitted PR has the possibility of being accepted.

Some things to keep in mind:
Expand All @@ -61,7 +61,7 @@ Some things to keep in mind:

### Writing good commit messages

Commit messages in go-opentelementry follow a specific set of conventions, which we discuss in this section.
Commit messages in go-opentelemetry follow a specific set of conventions, which we discuss in this section.

Here is an example of a good one:

Expand All @@ -81,30 +81,30 @@ Here is an example of a good one:

The first line of the change description is conventionally a short one-line summary of the change, prefixed by the primary affected package.

A rule of thumb is that it should be written so to complete the sentence "This change modifies go-opentelementry to _____."
A rule of thumb is that it should be written so to complete the sentence "This change modifies go-opentelemetry to _____."
That means it does not start with a capital letter, is not a complete sentence, and actually summarizes the result of the change.

Follow the first line by a blank line.

#### Main content

The rest of the description elaborates and should provide context for the change and explain what it does.
Write in complete sentences with correct punctuation, just like for your comments in go-opentelementry.
Write in complete sentences with correct punctuation, just like for your comments in go-opentelemetry.
Don't use HTML, Markdown, or any other markup language.
Add any relevant information, such as benchmark data if the change affects performance.
The [benchstat](https://godoc.org/golang.org/x/perf/cmd/benchstat) tool is conventionally used to format benchmark data for change descriptions.

#### Referencing issues

The special notation "Fixes #12345" associates the change with issue 12345 in the go-opentelementry issue tracker.
The special notation "Fixes #12345" associates the change with issue 12345 in the go-opentelemetry issue tracker.
When this change is eventually applied, the issue tracker will automatically mark the issue as fixed.


## Miscellaneous topics

### Copyright headers

Files in the go-opentelementry repository don't list author names, both to avoid clutter and to avoid having to keep the lists up to date.
Files in the go-opentelemetry repository don't list author names, both to avoid clutter and to avoid having to keep the lists up to date.
Instead, your name will appear in the change log.

New files that you contribute should use the standard copyright header:
Expand Down
22 changes: 11 additions & 11 deletions CONTRIBUTING.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# 如何贡献

感谢您对 tRPC-go-opentelementry 的关注和支持!
感谢您对 tRPC-go-opentelemetry 的关注和支持!

我们欢迎并感激任何形式的贡献,包括但不限于提交 issue、提供改进建议、改进文档、修复错误和添加功能。
本文档旨在为您提供详细的贡献指南,以帮助您更好地参与项目。
Expand All @@ -12,16 +12,16 @@
## 在贡献代码之前

项目欢迎代码补丁,但为了确保事情得到良好协调,您应该在开始工作之前讨论任何重大变更。
建议您在 issue 跟踪器中表明您的贡献意图,可以通过[认领现有 issue](https://github.com/trpc-ecosystem/go-opentelementry/issues)或[创建新 issue](https://github.com/trpc-ecosystem/go-opentelementry/issues/new) 来实现。
建议您在 issue 跟踪器中表明您的贡献意图,可以通过[认领现有 issue](https://github.com/trpc-ecosystem/go-opentelemetry/issues)或[创建新 issue](https://github.com/trpc-ecosystem/go-opentelemetry/issues/new) 来实现。

### 查看 issue 跟踪器

无论您已经知道要做哪些贡献,还是正在寻找想法,[issue 跟踪器](https://github.com/trpc-ecosystem/go-opentelementry/issues)始终是您的第一个去处。
无论您已经知道要做哪些贡献,还是正在寻找想法,[issue 跟踪器](https://github.com/trpc-ecosystem/go-opentelemetry/issues)始终是您的第一个去处。
issue 会被分类以管理工作流程。

大多数 issue 都会被标记为以下工作流标签之一:
- **NeedsInvestigation**:issue 尚未完全理解,需要分析以了解根本原因。
- **NeedsDecision**:issue 相对已经理解得很好,但 go-opentelementry 团队尚未决定解决 issue 的最佳方法。
- **NeedsDecision**:issue 相对已经理解得很好,但 go-opentelemetry 团队尚未决定解决 issue 的最佳方法。
在编写代码之前最好等待决策。
如果一段时间内没有决策且您有兴趣处理处于这种状态的 issue,请随时在 issue 评论中“ping”维护者。
- **NeedsFix**:issue 已完全理解,可以编写代码进行修复。
Expand All @@ -34,7 +34,7 @@ issue 会被分类以管理工作流程。
在编写代码之前,还可以检查设计是否合理;代码审查工具并非用于高层次的讨论。

在提交 issue 时,请确保回答以下五个问题:
1. 您正在使用哪个版本的go-opentelementry
1. 您正在使用哪个版本的go-opentelemetry
2. 您正在使用哪个操作系统和处理器架构(go env)?
3. 您做了什么?
4. 您期望看到什么?
Expand All @@ -46,7 +46,7 @@ issue 会被分类以管理工作流程。

遵循 [GitHub 流程](https://docs.github.com/en/get-started/quickstart/github-flow)来[创建 GitHub PR(Pull Request)](https://docs.github.com/en/get-started/quickstart/github-flow#create-a-pull-request)。

如果你是第一次向 go-opentelementry 项目提交 PR,那么在该 PR 的对话栏中会提醒你签署并提交[贡献者许可协议](https://github.com/trpc-group/cla-database/blob/main/Tencent-Contributor-License-Agreement.md)。
如果你是第一次向 go-opentelemetry 项目提交 PR,那么在该 PR 的对话栏中会提醒你签署并提交[贡献者许可协议](https://github.com/trpc-group/cla-database/blob/main/Tencent-Contributor-License-Agreement.md)。
只有当你签署过贡献者许可协议,你提交的 PR 才有可能被接受。
请记住以下几点:

Expand All @@ -59,7 +59,7 @@ issue 会被分类以管理工作流程。

### 编写良好的提交消息

go-opentelementry 中的提交消息遵循一套特定的约定,我们将在本节中讨论。
go-opentelemetry 中的提交消息遵循一套特定的约定,我们将在本节中讨论。

以下是一个良好的示例:
> math: improve Sin, Cos and Tan precision for very large arguments
Expand All @@ -74,28 +74,28 @@ go-opentelementry 中的提交消息遵循一套特定的约定,我们将在

变更描述的第一行通常是一个简短的一行摘要,描述变更的内容,并以主要受影响的包为前缀。

一个经验法则是,它应该被写成完成句子 "This change modifies go-opentelementry to _____." 这意味着它不以大写字母开头,不是一个完整的句子,而且确实概括了变更的结果。
一个经验法则是,它应该被写成完成句子 "This change modifies go-opentelemetry to _____." 这意味着它不以大写字母开头,不是一个完整的句子,而且确实概括了变更的结果。

在第一行之后空一行。

#### 主要内容

描述的其余部分应该详细说明,为变更提供上下文并解释它的作用。
像在 go-opentelementry 中的注释一样,使用正确的标点符号写完整的句子。
像在 go-opentelemetry 中的注释一样,使用正确的标点符号写完整的句子。
不要使用 HTML、Markdown 或任何其他标记语言。
添加任何相关信息,例如如果变更影响性能,请添加基准数据。
[benchstat](https://godoc.org/golang.org/x/perf/cmd/benchstat)工具通常用于为变更描述格式化基准数据。

#### 引用 issue

特殊表示法 "Fixes #12345" 将变更与 go-opentelementry issue 跟踪器中的 issue 12345关联。
特殊表示法 "Fixes #12345" 将变更与 go-opentelemetry issue 跟踪器中的 issue 12345关联。
当此变更最终应用时,issue 跟踪器将自动将该 issue 标记为已修复。

## 其他主题

### 版权声明

go-opentelementry 代码仓库中的文件不列出作者姓名,以避免混乱并避免不断更新列表。
go-opentelemetry 代码仓库中的文件不列出作者姓名,以避免混乱并避免不断更新列表。
而您的名字将出现在变更日志中。

您贡献的新文件应使用标准版权声明:
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ English | [中文](README.zh_CN.md)

# Go SDK

[![Go Reference](https://pkg.go.dev/badge/github.com/trpc-ecosystem/go-opentelementry.svg)](https://pkg.go.dev/github.com/trpc-ecosystem/go-opentelementry)
[![Go Reference](https://pkg.go.dev/badge/github.com/trpc-ecosystem/go-opentelemetry.svg)](https://pkg.go.dev/github.com/trpc-ecosystem/go-opentelemetry)
[![Go Report Card](https://goreportcard.com/badge/trpc.group/trpc-go/trpc-system/go-opentelemetry)](https://goreportcard.com/report/trpc.group/trpc-go/trpc-system/go-opentelemetry)
[![LICENSE](https://img.shields.io/badge/license-Apache--2.0-green.svg)](https://github.com/trpc-ecosystem/go-opentelementry/blob/main/LICENSE)
[![Releases](https://img.shields.io/github/release/trpc-ecosystem/go-opentelementry.svg?style=flat-square)](https://github.com/trpc-ecosystem/go-opentelementry/releases)
[![Tests](https://github.com/trpc-ecosystem/go-opentelementry/actions/workflows/prc.yml/badge.svg)](https://github.com/trpc-ecosystem/go-opentelementry/actions/workflows/prc.yml)
[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-opentelementry/branch/main/graph/badge.svg)](https://app.codecov.io/gh/trpc-ecosystem/go-opentelementry/tree/main)
[![LICENSE](https://img.shields.io/badge/license-Apache--2.0-green.svg)](https://github.com/trpc-ecosystem/go-opentelemetry/blob/main/LICENSE)
[![Releases](https://img.shields.io/github/release/trpc-ecosystem/go-opentelemetry.svg?style=flat-square)](https://github.com/trpc-ecosystem/go-opentelemetry/releases)
[![Tests](https://github.com/trpc-ecosystem/go-opentelemetry/actions/workflows/prc.yml/badge.svg)](https://github.com/trpc-ecosystem/go-opentelemetry/actions/workflows/prc.yml)
[![Coverage](https://codecov.io/gh/trpc-ecosystem/go-opentelemetry/branch/main/graph/badge.svg)](https://app.codecov.io/gh/trpc-ecosystem/go-opentelemetry/tree/main)

## quickstart

Expand Down
Loading