You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+37-24Lines changed: 37 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,20 +23,20 @@ Here are some guidelines to get started quickly and easily:
23
23
-[Conduct](#Conduct)
24
24
25
25
26
-
###Reporting An Issue
26
+
## Reporting An Issue
27
27
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.
29
29
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.
31
32
32
-
- Use the Issue Report Template below.
33
-
```
34
-
1.What did you do?
33
+
### Report a bug
35
34
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.
37
36
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.
40
40
41
41
42
42
## Working on java-tron
@@ -69,43 +69,56 @@ java-tron only has `master`, `develop`, `release-*`, `feature-*`, and `hotfix-*`
69
69
70
70
### Submitting Code
71
71
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.
73
77
74
-
* Fork code repository
75
-
Fork a new repository from tronprotocol/java-tron to your personal code repository
78
+
* Setup Local Environment
76
79
77
-
* Edit the code in the fork repository
80
+
Clone your fork repository to local and add the official repository as **upstream**.
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)
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.
84
92
```
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
88
98
```
89
99
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).
91
101
```
92
102
git checkout -b feature/branch_name develop
93
103
```
94
104
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).
96
108
```
97
109
git add .
98
110
git commit -m 'commit message'
99
111
```
100
-
Commit the new branch to your personal remote repository
112
+
113
+
Push the new branch to your fork repository
101
114
```
102
115
git push origin feature/branch_name
103
116
```
104
117
105
-
* Push code
118
+
* Submit a pull request
106
119
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.
0 commit comments