Skip to content

Commit 52b1723

Browse files
authored
Merge pull request #6576 from abn2357/fix_contributing
fix(docs): contributing.md
2 parents 721b165 + 25c9fc2 commit 52b1723

1 file changed

Lines changed: 37 additions & 24 deletions

File tree

CONTRIBUTING.md

Lines changed: 37 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,20 @@ Here are some guidelines to get started quickly and easily:
2323
- [Conduct](#Conduct)
2424

2525

26-
### Reporting An Issue
26+
## Reporting An Issue
2727

28-
If you're about to raise an issue because you think you've found a problem or bug with java-tron, please respect the following restrictions:
28+
If you have any question about java-tron, please search [existing issues](https://github.com/tronprotocol/java-tron/issues?q=is%3Aissue%20state%3Aclosed%20OR%20state%3Aopen) first to avoid duplicates. Your questions might already be under discussion or part of our roadmap. Checking first helps us streamline efforts and focus on new contributions.
2929

30-
- Please search for existing issues. Help us keep duplicate issues to a minimum by checking to see if someone has already reported your problem or requested your idea.
30+
### Ask a question
31+
Feel free to ask any java-tron related question to solve your doubt. Please click **Ask a question** in GitHub Issues, using [Ask a question](.github/ISSUE_TEMPLATE/ask-a-question.md) template.
3132

32-
- Use the Issue Report Template below.
33-
```
34-
1.What did you do?
33+
### Report a bug
3534

36-
2.What did you expect to see?
35+
If you think you've found a bug with java-tron, please click **Report a bug** in GitHub Issues, using [Report a bug](.github/ISSUE_TEMPLATE/report-a-bug.md) template.
3736

38-
3.What did you see instead?
39-
```
37+
### Request a feature
38+
39+
If you have any good feature suggestions for java-tron, please click **Request a feature** in GitHub Issues, using [Request a feature](.github/ISSUE_TEMPLATE/request-a-feature.md) template.
4040

4141

4242
## Working on java-tron
@@ -69,43 +69,56 @@ java-tron only has `master`, `develop`, `release-*`, `feature-*`, and `hotfix-*`
6969

7070
### Submitting Code
7171

72-
If you want to contribute codes to java-tron, please follow the following steps:
72+
If you want to contribute code to java-tron, please follow the following steps.
73+
74+
* Fork the Repository
75+
76+
Visit [tronprotocol/java-tron](https://github.com/tronprotocol/java-tron/) and click **Fork** to create a fork repository under your GitHub account.
7377

74-
* Fork code repository
75-
Fork a new repository from tronprotocol/java-tron to your personal code repository
78+
* Setup Local Environment
7679

77-
* Edit the code in the fork repository
80+
Clone your fork repository to local and add the official repository as **upstream**.
7881
```
7982
git clone https://github.com/yourname/java-tron.git
8083
81-
git remote add upstream https://github.com/tronprotocol/java-tron.git ("upstream" refers to upstream projects repositories, namely tronprotocol's repositories, and can be named as you like it. We usually call it "upstream" for convenience)
84+
cd java-tron
85+
86+
git remote add upstream https://github.com/tronprotocol/java-tron.git
8287
```
83-
Before developing new features, please synchronize your fork repository with the upstream repository.
88+
89+
* Synchronize and Develop
90+
91+
Before developing new features, please synchronize your local `develop` branch with the upstream repository and update to your fork repository.
8492
```
85-
git fetch upstream
86-
git checkout develop
87-
git merge upstream/develop --no-ff (Add --no-ff to turn off the default fast merge mode)
93+
git fetch upstream
94+
git checkout develop
95+
# `--no-ff` means to turn off the default fast merge mode
96+
git merge upstream/develop --no-ff
97+
git push origin develop
8898
```
8999
90-
Pull a new branch from the develop branch of your repository for local development. Please refer to [Branch Naming Conventions](#Branch-Naming-Conventions),
100+
Create a new branch for development. Please refer to [Branch Naming Conventions](#Branch-Naming-Conventions).
91101
```
92102
git checkout -b feature/branch_name develop
93103
```
94104
95-
Write and commit the new code when it is completed. Please refer to [Commit Messages](#Commit-Messages)
105+
* Commit and Push
106+
107+
Write and commit the new code when it is completed. Please refer to [Commit Messages](#Commit-Messages).
96108
```
97109
git add .
98110
git commit -m 'commit message'
99111
```
100-
Commit the new branch to your personal remote repository
112+
113+
Push the new branch to your fork repository
101114
```
102115
git push origin feature/branch_name
103116
```
104117
105-
* Push code
118+
* Submit a pull request
106119
107-
Submit a pull request (PR) from your repository to `tronprotocol/java-tron`.
108-
Please be sure to click on the link in the red box shown below. Select the base branch for tronprotocol and the compare branch for your personal fork repository.
120+
Submit a pull request (PR) from your fork repository to `tronprotocol/java-tron`.
121+
Please be sure to click on the link in the red box shown below. Select the base branch for `tronprotocol/java-tron` and the compare branch for your fork repository.
109122
![image](https://raw.githubusercontent.com/tronprotocol/documentation-en/master/images/javatron_pr.png)
110123
111124

0 commit comments

Comments
 (0)