Skip to content

Commit

Permalink
Merge pull request #103 from Pil0tXia/actions_101
Browse files Browse the repository at this point in the history
[ISSUE #101] Remind contributors to enable Actions in forked repo to ease the reviewers approving workflows
  • Loading branch information
qqeasonchen authored Jul 24, 2023
2 parents a770d65 + e9a3200 commit 8a98a70
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 10 deletions.
22 changes: 17 additions & 5 deletions community/contribute/01-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,18 @@ If you can't see CheckStyle Configuration section under Import Scheme, you can i
You can also use `./gradlew check` to check the code style.
(Note: this command will check all file in project, when you submit a pr, the ci will only check the file has been changed in this pr).

### Continuous Integration

This configuration is not mandatory. You may enable GitHub Actions workflows in the Fork repository to promptly observe if new commits introduce compilation errors and reduce the waiting time for CI results after submitting a PR.

To do this, simply set `Workflow Permissions` to `Read and write permissions` at the following location:

```
Your Forked Repository -> Settings -> Actions -> General -> Workflow Permissions
```

![](../../static/images/contribute/enable-ci.png)

### Workflow

Here are the workflow for contributors:
Expand Down Expand Up @@ -70,17 +82,17 @@ git rebase upstream_master

## Explanation

The original warehouse: https://github.com/apache/incubator-eventmesh The apache warehouse of eventmesh is called the original warehouse in the text.
The original repository: https://github.com/apache/eventmesh Apache's EventMesh repository is called the original repository in this article.

The Fork library: From https://github.com/apache/eventmesh fork to your own personal repository to become a fork library.
The Forked repository: A fork from the original repository to your own personal repository is a fork repository.

So fork the original EventMesh repository into your own repository.
So please fork the original EventMesh repository into your own repository.

## Development branch

**The current development branch of eventmesh is Master. Please submit PR to this branch.**
**The current development branch of EventMesh is Master. Please submit PR to this branch.**

- We recommend that you create a new branch in your repository for development and submit the branch to the master branch of eventmesh.
- We recommend that you create a new branch in your repository for development and submit the branch to the master branch of EventMesh.

## Contribution Categories

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,18 @@ Editor -> Code Style -> Java -> Scheme -> Import Scheme -> CheckStyle Configurat
您还可以使用 ./gradlew check 来检查代码风格。
(注意:此命令将检查项目中的所有文件,当您提交 pr 时,ci 将仅检查此 pr 中已更改的文件)。

### CI 持续集成

此配置不是必须的。您可以在 Fork 仓库中开启 GitHub Actions 工作流,来及时观察新的 commit 是否会引入编译错误,并减少在提交 PR 后等待 CI 运行结果的时间。

在以下位置将`Workflow Permissions`设置为`Read and write permissions`即可:

```
Your Forked Repository -> Settings -> Actions -> General -> Workflow Permissions
```

![](../../../../../static/images/contribute/enable-ci.png)

### 工作流程

以下是贡献者的工作流程:
Expand Down Expand Up @@ -72,17 +84,17 @@ git rebase upstream_master

## 解释

[原仓库](https://github.com/apache/incubator-eventmesh )eventmesh的apache仓库在文中称为原仓库
[原仓库](https://github.com/apache/eventmesh )Apache 的 EventMesh 仓库在文中称为原仓库

[Fork仓库](https://github.com/apache/eventmesh):从原仓库fork到你自己的个人仓库成为一个fork库
Fork 仓库:从原仓库 fork 到您的账号中的个人仓库是一个 Fork 仓库

因此,将原始 EventMesh 存储库 fork 到您自己的存储库中。
因此,请将原始 EventMesh 存储库 fork 到您自己的存储库中。

## 开发分支

**eventmesh目前的开发分支是Master。请向该分支提交 PR。**
**EventMesh 目前的开发分支是 Master。请向该分支提交 PR。**

> 我们建议您在您的开发仓库中创建一个新的分支,并将该分支提交pull request到eventmesh 的master 分支。
> 我们建议您在您的开发仓库中创建一个新的分支,并将该分支提交 Pull Request 到 EventMesh 的 master 分支。
## 贡献类别

Expand Down
Binary file added static/images/contribute/enable-ci.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8a98a70

Please sign in to comment.