Skip to content

Commit ccd4665

Browse files
authored
Merge pull request #2 from xszconfig/fix-wording
fix wording and wrong link
2 parents 2ca7f76 + 48b0058 commit ccd4665

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# 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.
33

44
## issues
55
We use Git Issues to track public bugs and feature requests.
66

77
### 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.
99

1010
### Reporting New Issues
1111
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
3939
```
4040

4141
### 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.
4343

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:
4545

4646
1. Fork the repo and create your branch from `master` or `hotfix`.
4747
2. Update code or documentation if you have changed APIs.
4848
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.
5050
5. Test and test again your code.
5151
6. Now, you can submit your pull request on `dev` or `hotfix` branch.
5252

@@ -57,4 +57,4 @@ Use [Code Style](https://github.com/Tencent/tinker/blob/master/checkstyle.xml) f
5757

5858
## License
5959
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)

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Tinker
22
[![license](http://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat)](https://github.com/Tencent/tinker/blob/master/LICENSE)
33

4-
Tinker is a hot-fix solution library for Android, it supports dex, library and resources update without reinstall apk.
4+
Tinker is a hot-fix solution library for Android, it supports dex, library and resources update without reinstalling apk.
55

66
![tinker.png](assets/tinker.png)
77

@@ -20,7 +20,7 @@ Then you need to "apply" the plugin and add dependencies by adding the following
2020

2121
```gradle
2222
dependencies {
23-
//optional, help to gen the final application
23+
//optional, help to generate the final application
2424
compile('com.tencent.tinker:tinker-android-anno:1.6.0')
2525
//tinker's main Android lib
2626
compile('com.tencent.tinker:tinker-android-lib:1.6.0')
@@ -37,7 +37,7 @@ If your app has a class that subclasses android.app.Application, then you need t
3737
+public class SampleApplicationLike extends DefaultApplicationLike
3838
```
3939

40-
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:
4141

4242
```java
4343
public class SampleApplication extends TinkerApplication {
@@ -53,7 +53,7 @@ public class SampleApplication extends TinkerApplication {
5353
}
5454
```
5555

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
5757

5858
```java
5959
@DefaultLifeCycle(
@@ -64,7 +64,7 @@ public class SampleApplicationLike extends DefaultApplicationLike
6464

6565
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).
6666

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.
6868

6969
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).
7070

@@ -80,4 +80,4 @@ Any problem?
8080
For more information about contributing issues or pull requests, see our [Tinker Contributing Guide](https://github.com/Tencent/tinker/blob/master/CONTRIBUTING.md).
8181

8282
## 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

Comments
 (0)