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
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
# Contributing to Tinker
2
-
Welcome to [report Issues](https://github.com/Tencent/tinker/issues) or [pull requests](https://github.com/Tencent/tinker/pulls). It's recommended to read the following Contributing Guild first to make contributing earlier.
2
+
Welcome to [report Issues](https://github.com/Tencent/tinker/issues) or [pull requests](https://github.com/Tencent/tinker/pulls). It's recommended to read the following Contributing Guide first before contributing.
3
3
4
4
## issues
5
5
We use Git Issues to track public bugs and feature requests.
6
6
7
7
### Search Known Issues First
8
-
Please search the exist issues to see if any similar issue or feature request has already been filed. You shold try to make sure your issue doesn't already exist.
8
+
Please search the existing issues to see if any similar issue or feature request has already been filed. You should make sure your issue isn't redundant.
9
9
10
10
### Reporting New Issues
11
11
If you open an issue, the more information the better. Such as detailed description, screenshot or video of your problem, logcat or code blocks for your crash.
@@ -39,14 +39,14 @@ feature/bugfix PR
39
39
```
40
40
41
41
### Make Pull Requests
42
-
The code team will monitor all pull request, we run some code check and test on it. After all tests passing, we will accecpt this pr. But it won't merge to `master` branch at once, which have some delay.
42
+
The code team will monitor all pull request, we run some code check and test on it. After all tests passed, we will accecpt this PR. But it won't merge to `master` branch at once, which have some delay.
43
43
44
-
Before submitting a pull request, please make sure the following is done
44
+
Before submitting a pull request, please make sure the followings are done:
45
45
46
46
1. Fork the repo and create your branch from `master` or `hotfix`.
47
47
2. Update code or documentation if you have changed APIs.
48
48
3. Add the copyright notice to the top of any new files you've added.
49
-
4.Make sure your code lints and checkstyles.
49
+
4.Check your code lints and checkstyles.
50
50
5. Test and test again your code.
51
51
6. Now, you can submit your pull request on `dev` or `hotfix` branch.
52
52
@@ -57,4 +57,4 @@ Use [Code Style](https://github.com/Tencent/tinker/blob/master/checkstyle.xml) f
57
57
58
58
## License
59
59
By contributing to Tinker, you agree that your contributions will be licensed
60
-
under its [BSD LICENSE](https://github.com/Tencent/tinker/blob/master/LICENSE)
60
+
under its [BSD LICENSE](https://github.com/Tencent/tinker/blob/master/LICENSE)
Now you should change your `Application` class, which will be a subclass of [TinkerApplication](https://github.com/Tencent/tinker/blob/master/tinker-android/tinker-android-loader/src/main/java/com/tencent/tinker/loader/app/TinkerApplication.java). As you can see from its API, it is an abstract class that does not have a default constructor, so you must define a no-arg constructor as follows:
40
+
Now you should change your `Application` class, make it a subclass of [TinkerApplication](https://github.com/Tencent/tinker/blob/master/tinker-android/tinker-android-loader/src/main/java/com/tencent/tinker/loader/app/TinkerApplication.java). As you can see from its API, it is an abstract class that does not have a default constructor, so you must define a no-arg constructor:
41
41
42
42
```java
43
43
public class SampleApplication extends TinkerApplication {
@@ -53,7 +53,7 @@ public class SampleApplication extends TinkerApplication {
53
53
}
54
54
```
55
55
56
-
Use `tinker-android-anno` to generate your `Application` is more recommended, you can just add an annotation for your [SampleApplicationLike](http://git.code.oa.com/tinker/tinker/blob/master/tinker-sample-android/app/src/main/java/tinker/sample/android/app/SampleApplicationLike.java) class
56
+
Use `tinker-android-anno` to generate your `Application` is recommended, you just need to add an annotation for your [SampleApplicationLike](https://github.com/Tencent/tinker/blob/master/tinker-sample-android/app/src/main/java/tinker/sample/android/app/SampleApplicationLike.java) class
57
57
58
58
```java
59
59
@DefaultLifeCycle(
@@ -64,7 +64,7 @@ public class SampleApplicationLike extends DefaultApplicationLike
64
64
65
65
How to install tinker? learn more at the sample [SampleApplicationLike](https://github.com/Tencent/tinker/blob/master/tinker-sample-android/app/src/main/java/tinker/sample/android/app/SampleApplicationLike.java).
66
66
67
-
For proguard, we have already change the proguard config automatic, and also generate the multiDex keep proguard file for you.
67
+
For proguard, we have already made the proguard config automatic, and tinker will also generate the multiDex keep proguard file for you.
68
68
69
69
For more tinker configurations, learn more at the sample [app/build.gradle](https://github.com/Tencent/tinker/blob/master/tinker-sample-android/app/build.gradle).
70
70
@@ -80,4 +80,4 @@ Any problem?
80
80
For more information about contributing issues or pull requests, see our [Tinker Contributing Guide](https://github.com/Tencent/tinker/blob/master/CONTRIBUTING.md).
81
81
82
82
## License
83
-
Tinker is under the BSD license. See the [LICENSE](https://github.com/Tencent/tinker/blob/master/LICENSE) file for details.
83
+
Tinker is under the BSD license. See the [LICENSE](https://github.com/Tencent/tinker/blob/master/LICENSE) file for details.
0 commit comments