From 48b0058a640e6872dd01f55924071a09337f50d3 Mon Sep 17 00:00:00 2001 From: Shaoze Xie Date: Sat, 24 Sep 2016 15:03:00 +0800 Subject: [PATCH] fix wording and wrong link --- CONTRIBUTING.md | 12 ++++++------ README.md | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94ff98a9..13bc8569 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,11 @@ # Contributing to Tinker -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. +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. ## issues We use Git Issues to track public bugs and feature requests. ### Search Known Issues First -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. +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. ### Reporting New Issues 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 ``` ### Make Pull Requests -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. +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. -Before submitting a pull request, please make sure the following is done +Before submitting a pull request, please make sure the followings are done: 1. Fork the repo and create your branch from `master` or `hotfix`. 2. Update code or documentation if you have changed APIs. 3. Add the copyright notice to the top of any new files you've added. -4. Make sure your code lints and checkstyles. +4. Check your code lints and checkstyles. 5. Test and test again your code. 6. Now, you can submit your pull request on `dev` or `hotfix` branch. @@ -57,4 +57,4 @@ Use [Code Style](https://github.com/Tencent/tinker/blob/master/checkstyle.xml) f ## License By contributing to Tinker, you agree that your contributions will be licensed -under its [BSD LICENSE](https://github.com/Tencent/tinker/blob/master/LICENSE) \ No newline at end of file +under its [BSD LICENSE](https://github.com/Tencent/tinker/blob/master/LICENSE) diff --git a/README.md b/README.md index 51e5e319..d73604f0 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ## Tinker [![license](http://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat)](https://github.com/Tencent/tinker/blob/master/LICENSE) -Tinker is a hot-fix solution library for Android, it supports dex, library and resources update without reinstall apk. +Tinker is a hot-fix solution library for Android, it supports dex, library and resources update without reinstalling apk. ![tinker.png](assets/tinker.png) @@ -20,7 +20,7 @@ Then you need to "apply" the plugin and add dependencies by adding the following ```gradle dependencies { - //optional, help to gen the final application + //optional, help to generate the final application compile('com.tencent.tinker:tinker-android-anno:1.6.0') //tinker's main Android lib 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 +public class SampleApplicationLike extends DefaultApplicationLike ``` -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: +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: ```java public class SampleApplication extends TinkerApplication { @@ -53,7 +53,7 @@ public class SampleApplication extends TinkerApplication { } ``` -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 +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 ```java @DefaultLifeCycle( @@ -64,7 +64,7 @@ public class SampleApplicationLike extends DefaultApplicationLike 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). -For proguard, we have already change the proguard config automatic, and also generate the multiDex keep proguard file for you. +For proguard, we have already made the proguard config automatic, and tinker will also generate the multiDex keep proguard file for you. 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). @@ -80,4 +80,4 @@ Any problem? For more information about contributing issues or pull requests, see our [Tinker Contributing Guide](https://github.com/Tencent/tinker/blob/master/CONTRIBUTING.md). ## License -Tinker is under the BSD license. See the [LICENSE](https://github.com/Tencent/tinker/blob/master/LICENSE) file for details. \ No newline at end of file +Tinker is under the BSD license. See the [LICENSE](https://github.com/Tencent/tinker/blob/master/LICENSE) file for details.