Skip to content

Commit

Permalink
femas sourcecode sync to polarismesh
Browse files Browse the repository at this point in the history
  • Loading branch information
zilongTong committed Feb 23, 2022
1 parent d2b441a commit 506161e
Show file tree
Hide file tree
Showing 662 changed files with 55,255 additions and 1 deletion.
41 changes: 41 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# IntelliJ project files
.factorypath
.idea/
*.iml
out
gen

# Maven
target/
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
pom.xml.next
release.properties
dependency-reduced-pom.xml
buildNumber.properties
.mvn/timing.properties
!/.mvn/wrapper/maven-wrapper.jar
*/.flattened-pom.xml
.flattened-pom.xml

# Eclipse
.classpath
.settings/
.project

/logs
*/logs
*.log

env.sh

# System related
*.DS_Store
Thumbs.db


# Atom console
node_modules
dist
.vscode
61 changes: 61 additions & 0 deletions CONTRIBUTING-zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# 贡献Femas

**[`English`](./CONTRIBUTING.md) | `简体中文`**

欢迎加入我们! 本文档是关于如何为 Femas 做出贡献的指南。

如果您有好的意见或建议,欢迎创建[`Issues`](https://github.com/Tencent/Femas/issues/new)[`Pull Requests`](https://github.com/Tencent/Femas/pulls) ,为Femas开源社区做贡献。 Femas 持续招募贡献者,即使是在 issue 中回答问题,或者做一些简单的 bug 修复,都会对我们有很大的帮助。

**[腾讯开源激励计划](https://opensource.tencent.com/contribution)鼓励开发者参与贡献,期待您的加入。**

-------------------


## 行为准则
> 请务必阅读并遵守我们的 **[行为准则](./Code-of-Conduct.md)**
## 报告 Bugs/提交issue
* 搜索 [issues](https://github.com/Tencent/Femas/issues) 确保该错误未被提出,以免重复提交。
* 通过社区微信群或邮件与社区取得联系,确认bug或者新的feature(可选)。
* [新建一个issue](https://github.com/Tencent/Femas/issues/new),包含**标题和详细描述、代码示例、截图或短视频**以帮助我们定位问题。
## 开始贡献
Femas社区贡献者主要有四种角色类型:
- 用户(在企业环境调研或正在落地Femas的社区用户)
- 贡献者(给项目带来价值或者合并过PR的人)
- 提交者(PR达到一定数量,由社区评委会评定提升为提交者角色,成为社区骨干成员)
- PMC(项目管理员)

我们鼓励新人积极参与Femas 项目,我们也非常欢迎企业用户使用Femas,给社区提供落地案例,社区也会全力支持企业用户落地,并将精彩的案例分享给大家,互联网的精神就是分享,Femas社区也将持续将腾讯内部微服务最佳实践方法论和业界共享。

### Pull Request指南
> 首先从[issues列表](https://github.com/Tencent/Femas/issues) 中选择一个想要修复的问题,任何PR都必须关联一个有效的issue,或者先和社区成员联系,确认该issue无人认领,如果有多人同时认领同一个issue,社区将会经过评审,将issue分配给方案最合理的维护者。
Femas以 **`develop`** 分支作为开发基准分支,下面是具体操作流程:
1.**`develop`分支** fork代码到你自己GitHub的仓库。
2. 创建一个新分支,分支名称可以issue号命名例如(fix_issue#007)。
3. 提交更改,提交之前请确认你的分支和源分支代码同步。
4. 将你的提交推送到你的fork仓库。
5.**`develop`分支** 创建拉取请求。

提交PR注意事项:
- 请务必参照[拉取请求模板](./PULL_REQUEST_TEMPLATE.md)
- 请确认PR关联有效issue,否则PR将被拒绝。
- 请在新创建的文件中添加许可和版权声明。
- 确保一致的代码风格,做充分的测试。
- 如果PR 包含大量更改,例如组件重构或新组件,请详细说明其设计和用法。
- 确保提交信息尽量清晰简洁。

### 代码审查
所有合并到官方的代码都会经过社区review评审,一般这些工作会分配给Committer或者PMC,当然我们也会通过自动化的方式,规避一些凌乱的代码风格或者潜在的漏洞,我们必须保持整个代码仓库高的质量标准:
> - 可读性 :重要的代码应该有详细的注释和文档记录, API 应该有 Javadoc。
> - 优雅:通用组件和函数要有合理的设计,具有很好的可扩展性,标准化、模块化的代码设计是Femas的内核。
> - 可维护性 :确保一致的代码风格,符合我们的 [代码规范](style/codeStyle.md)
> - 可测试性 :核心feature的相关代码应该被单元测试用例覆盖。
## 关于源代码的问题
#### [常见问题]()
#### 加入我们的社区交流群

![image](https://user-images.githubusercontent.com/22976760/153165352-361517e8-0712-4194-938f-2ea712ddf0a6.png)


59 changes: 59 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Contribute to Femas

**`English` | [`简体中文`](./CONTRIBUTING-zh.md)**

Welcome to join us! This document is a guide on how to contribute to Femas.

If you have good comments or suggestions, please create [`Issues`](https://github.com/Tencent/Femas/issues/new) or [`Pull Requests`](https://github.com/Tencent/Femas/pulls), to contribute to the Femas open source community. Femas continues to recruit contributors, even if it is answering questions in the issue, or doing some simple bug fixes, it will be of great help to us.

[Tencent Open Source Incentive Program](https://opensource.tencent.com/contribution) encourages developers to participate in contributions, and look forward to your joining.

-------------------


## code of conduct
> Please be sure to read and follow our **[Code of Conduct](./Code-of-Conduct.md)**.
## Report Bugs/Submit an issue
* Search for [issues](https://github.com/Tencent/Femas/issues) to ensure that the error has not been raised, so as to avoid repeated submissions.
* Get in touch with the community through the community WeChat group or email to confirm bugs or new features (optional).
* [Create a new issue](https://github.com/Tencent/Femas/issues/new) , including **title and detailed description, code examples, screenshots or short videos** to help us locate the issue .
## Start contributing
Femas community contributors mainly have four types of roles:
- Users (community users who research in the corporate environment or who are currently landing Femas)
- Contributors (people who bring value to the project or merge PR)
- Submitters (PR reaches a certain number and will be promoted to the submitter role by the community jury and become a backbone member of the community)
- PMC (Project Manager)

We encourage newcomers to actively participate in the Femas project. We also welcome corporate users to use Femas and provide the community with landing cases. The community will fully support the corporate users in landing and share wonderful cases with everyone. The spirit of the Internet is sharing, and the Femas community We will continue to share Tencent's internal microservice best practice methodology with the industry.

### Pull Request Guide
> First select an issue that you want to fix from [issues list](https://github.com/Tencent/Femas/issues), any PR must be associated with a valid issue, or first with community members Contact and confirm that the issue is unclaimed. If multiple people claim the same issue at the same time, the community will review the issue and assign the issue to the most reasonable maintainer.
Femas uses the **`develop`** branch as the development benchmark branch. The following is the specific operation process:
1. Fork the code from **`develop` branch** to your own GitHub repository.
2. Create a new branch, the branch name can be named with issue number, for example (fix_issue#007).
3. Submit the changes, please confirm your branch and source branch code synchronization before submitting.
4. Push your commit to your fork repository.
5. Create a pull request to the **`develop` branch**.

Matters needing attention when submitting PR:
- Please refer to [Pull Request Template](./PULL_REQUEST_TEMPLATE.md).
- Please confirm that the PR is associated with a valid issue, otherwise the PR will be rejected.
- Please add a license and copyright notice to the newly created file.
- Ensure a consistent code style and do adequate testing.
- If the PR contains a lot of changes, such as component refactoring or new components, please elaborate on its design and usage.
- Ensure that the submitted information is as clear and concise as possible.

### Code review
All code merged into the official code will be reviewed by the community. Generally, these tasks will be assigned to Committer or PMC. Of course, we will also avoid some messy code styles or potential vulnerabilities through automated methods. We must keep the entire code warehouse high. Quality Standard:
> - Readability: Important code should have detailed comments and documentation, and API should have Javadoc.
> - Elegance: Common components and functions must have a reasonable design and have good scalability. Standardized and modular code design is the core of Femas.
> - Maintainability: to ensure a consistent code style, in line with our [Code Style](style/codeStyle.md).
> - Testability: The relevant code of the core feature should be covered by unit test cases.
## Questions about the source code
#### [FAQ]()
#### Join our community group
![image](https://user-images.githubusercontent.com/22976760/153164965-ff5d0f2b-5990-4c8e-a7dc-2791fd1ca8bd.png)

6 changes: 6 additions & 0 deletions Code-of-Conduct-zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Femas社区行为准则

**Femas社区成员和参与其中的每个人都遵守[CNCF行为准则](https://github.com/cncf/foundation/blob/master/code-of-conduct.md)**

如果遇到辱骂、骚扰或其他不可接受的行为,可以通过电子邮件联系 Femas 行为准则委员会报告,
邮箱地址:[email protected]
5 changes: 5 additions & 0 deletions Code-of-Conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Femas Community Code of Conduct

**Femas and everyone participating in it follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).**

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Femas Code of Conduct Committee via email:femas_community@qq.com
21 changes: 21 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
FROM hub.grepcode.cn:55582/basic/ubuntu:20.04

LABEL maintainer "minghhou <minghhou>"

ENV BUILD_MODE="docker"

RUN sed -i 's/archive.ubuntu.com/mirrors.tencent.com/g' /etc/apt/sources.list && \
sed -i 's/security.ubuntu.com/mirrors.tencent.com/g' /etc/apt/sources.list

RUN apt update && apt install openjdk-8-jdk maven iproute2 -y

COPY ./ /usr/local/src/femas

RUN echo "start build docker" && cd /usr/local/src/femas && mvn -Dmaven.test.skip=true clean install -U

COPY ./entrypoint.sh /entrypoint.sh

RUN chmod +x /entrypoint.sh

ENTRYPOINT /entrypoint.sh

Loading

0 comments on commit 506161e

Please sign in to comment.