Skip to content

Commit fad09d8

Browse files
authored
fix: doc error (#24)
* fix doc error
1 parent 87feeb5 commit fad09d8

File tree

4 files changed

+20
-15
lines changed

4 files changed

+20
-15
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ libs/
1313
metric_monitor/datadir
1414
private_net/datadir
1515
tron-docker.iml
16+
bin/

.pre-commit-config.yaml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,10 @@ repos:
1313
- repo: 'https://github.com/jumanjihouse/pre-commit-hooks'
1414
rev: 3.0.0
1515
hooks:
16+
- id: shellcheck
1617
- id: script-must-have-extension
1718
- id: git-dirty
1819
- id: git-check
19-
- repo: 'https://github.com/koalaman/shellcheck-precommit'
20-
rev: v0.7.2
21-
hooks:
22-
- id: shellcheck
2320
- repo: local # check java files format use a customized script
2421
hooks:
2522
- id: checkstyle

CONTRIBUTING.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,22 @@
33
tron-docker is an open-source project designed to facilitate the usage of the TRON network. We understand that there is much left to be desired, and if you see any room for improvement, please let us know. Thank you. All contributed code will be covered by the [LGPLv3 license](https://github.com/tronprotocol/tron-docker/blob/main/LICENSE) of this project.
44

55
Here are some guidelines to get started quickly and easily:
6-
- [Before contribution](#Before-contribution)
7-
- [Contribute to tron-docker](#Contribute-to-tron-docker)
8-
- [Key Branches](#Key-Branches)
9-
- [Submitting Code Steps](#Submitting-Code-Steps)
10-
- [Commit Messages](#Commit-Messages)
11-
- [Branch Naming Conventions](#Branch-Naming-Conventions)
12-
- [Pull Request Best Practise](#Pull-request-best-practise)
13-
- [Special Situations And How To Deal With Them](#Special-Situations-And-How-To-Deal-With-Them)
14-
- [Conduct](#Conduct)
6+
- [Contributing](#contributing)
7+
- [Before contribution](#before-contribution)
8+
- [Ask a question](#ask-a-question)
9+
- [Reporting an issue](#reporting-an-issue)
10+
- [Request a feature](#request-a-feature)
11+
- [Contribute to tron-docker](#contribute-to-tron-docker)
12+
- [Key branches](#key-branches)
13+
- [Submitting code steps](#submitting-code-steps)
14+
- [Fork then make changes](#fork-then-make-changes)
15+
- [Linting](#linting)
16+
- [Push code](#push-code)
17+
- [Commit messages](#commit-messages)
18+
- [Branch naming conventions](#branch-naming-conventions)
19+
- [Pull request best practise](#pull-request-best-practise)
20+
- [Special situations and how to deal with them](#special-situations-and-how-to-deal-with-them)
21+
- [Conduct](#conduct)
1522

1623
## Before contribution
1724

@@ -94,7 +101,7 @@ Commit the new branch to your personal remote repository.
94101

95102
#### Linting
96103

97-
tron-docker CI uses [pre-commit](https://pre-commit.com/) to lint all code within the repo. Add it to your local following the [installation](https://pre-commit.com/#installation). Check [.pre-commit-config.yaml](.pre-commit-config-fix.yaml) for existing validators.
104+
tron-docker CI uses [pre-commit](https://pre-commit.com/) to lint all code within the repo. Add it to your local following the [installation](https://pre-commit.com/#installation). And ensure ShellCheck is also installed, refer to [installation](https://github.com/koalaman/shellcheck?tab=readme-ov-file#installing). Check [.pre-commit-config.yaml](.pre-commit-config-fix.yaml) for existing validators.
98105

99106
#### Push code
100107

tools/docker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If you encounter any problems during the build or testing process, please refer
77

88
Follow the [getting-started](https://github.com/tronprotocol/tron-docker/blob/main/README.md#getting-started) guide to download Docker and the tron-docker repository. Then, navigate to the gradlew directory.
99
```
10-
cd /java-tron/tools/gradlew
10+
cd ./tools/gradlew
1111
```
1212
Container testing uses the [Goss](https://github.com/goss-org/goss/blob/v0.4.9/README.md) tool, a YAML-based testing framework for validating service states. While no additional installation is required, it is beneficial to learn the basic usage of [Goss with container](https://goss.readthedocs.io/en/stable/container_image/) to help you better understand the following testing scripts.
1313

0 commit comments

Comments
 (0)