Skip to content

feat: add contributing guide link to README files #19

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.

Sign up for GitHub

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

Merged
shalousun merged 1 commit into from
Jul 11, 2026
Merged

feat: add contributing guide link to README files #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">Smart-Doc Project</h1>

![maven](https://img.shields.io/maven-central/v/com.ly.smart-doc/smart-doc)
![maven](https://img.shields.io/maven-central/v/com.github.shalousun/smart-doc)
[![License](https://img.shields.io/badge/license-Apache%202-green.svg)](https://www.apache.org/licenses/LICENSE-2.0)
![number of issues closed](https://img.shields.io/github/issues-closed-raw/smart-doc-group/smart-doc)
![closed pull requests](https://img.shields.io/github/issues-pr-closed/smart-doc-group/smart-doc)
Expand Down Expand Up @@ -56,6 +56,10 @@ You could build with the following commands. (`JDK 1.8` is required to build the
mvn clean install -Dmaven.test.skip=true
```

## Contributing

Contributions are welcome! Please refer to the [Contributing Guide](https://smart-doc-group.github.io/guide/community/contributing) to get started.

## Who is using

These are only part of the companies using `smart-doc`, for reference only. If you are using smart-doc,
Expand Down
6 changes: 5 additions & 1 deletion README_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center"><a href="https://github.com/smart-doc-group/smart-doc" target="_blank">Smart-Doc Project</a></h1>

![maven](https://img.shields.io/maven-central/v/com.ly.smart-doc/smart-doc)
![maven](https://img.shields.io/maven-central/v/com.github.shalousun/smart-doc)
[![License](https://img.shields.io/badge/license-Apache%202-green.svg)](https://www.apache.org/licenses/LICENSE-2.0)
![number of issues closed](https://img.shields.io/github/issues-closed-raw/smart-doc-group/smart-doc)
![closed pull requests](https://img.shields.io/github/issues-pr-closed/smart-doc-group/smart-doc)
Expand Down Expand Up @@ -62,6 +62,10 @@ $\color{red}{你给我的star，胜过所有读过的诗—smart-doc}$
mvn clean install -Dmaven.test.skip=true
```

## Contributing

欢迎为 `smart-doc` 贡献代码！请参考[贡献指南](https://smart-doc-group.github.io/zh/guide/community/contributing)了解如何参与项目。

## License

`smart-doc` is under the Apache 2.0 license. See
Expand Down