Skip to content

Commit

Permalink
Merge pull request #2 from xszconfig/fix-wording
Browse files Browse the repository at this point in the history
fix wording and wrong link
  • Loading branch information
tys282000 committed Sep 24, 2016
2 parents 2ca7f76 + 48b0058 commit ccd4665
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.

Expand All @@ -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)
under its [BSD LICENSE](https://github.com/Tencent/tinker/blob/master/LICENSE)
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -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')
Expand All @@ -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 {
Expand All @@ -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(
Expand All @@ -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).

Expand All @@ -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.
Tinker is under the BSD license. See the [LICENSE](https://github.com/Tencent/tinker/blob/master/LICENSE) file for details.

0 comments on commit ccd4665

Please sign in to comment.