From 0f31ec818be7f693ba4b73a3a1e5a11ca78631ee Mon Sep 17 00:00:00 2001 From: JugglerShu Date: Tue, 1 Mar 2016 00:09:57 +0900 Subject: [PATCH 1/7] Create issue template --- .github/ISSUE_TEMPLATE.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 64392367..a33e99aa 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,2 +1,25 @@ + + +# Description +[Write simple description here. If the title describes it well, just delete this.] + +# Operation +[Describe the operation you did. Also include your text on which you operate if it is related to text editing.] + +# Expected behaviour +[Write here] + +# Environments + - Xcode Version [ ] + - XVim branch and revision [ ] + - Keyboard Language [ ] + - Input source language [ ] + +# Crash log (if any) + + [ Paste the log here ] -# Issue Template \ No newline at end of file From 27a6fca13440845f6ee8d459f45cebb01e551c3c Mon Sep 17 00:00:00 2001 From: JugglerShu Date: Tue, 1 Mar 2016 00:16:40 +0900 Subject: [PATCH 2/7] Make separate CONTRIBUTING file --- .github/CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++++++++++++- README.md | 44 ++--------------------------------------- 2 files changed, 44 insertions(+), 43 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c1a6bc9d..6654ca41 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,2 +1,43 @@ -# Contributing \ No newline at end of file +## Bug issue handling + + Reported bugs are handled following order. + + 1. Confirm if the bug reproduce and the issue labeled as 'Bug' + 2. Fix the bug in 'develop' branch + 3. Confirm the fix by the reporter + 4. The issue is labeled 'Done' + 5. Confirm that the fix does not make another side effect. + 6. Merged into 'master' + 7. The issue is closed. + + This order is only applied to 'Bug' issues. + +## Contributions + Any suggestions, bug reports or feature requests are welcome. + + If you want to add a feature or fix bugs by yourself the following videos are good help for you. + - [How to get debug log](http://www.youtube.com/watch?v=50Bhu8setlc) + - [How to debug XVim](http://www.youtube.com/watch?v=AbC6f86VW9A) + - [How to write a test case](http://www.youtube.com/watch?v=kn-kkRTtRcE) + + Any pull requests are very much appreciated. Before you make a pull request see [Make a Pull Request](Documents/Developers/PullRequest.md) + +Watch the videos mentioned earlier for a full tutorial on developing, debugging and testing XVim. Here is a very simple guide to get you started. + +### Debugging + 1. Make sure you have Xcode.app installed at /Applications/Xcode.app, if that's true just open XVim.xcodeproj and Run (CMD + R). You can ignore the rest steps. + 2. If you have Xcode installed at a different path, follow these steps. + 3. Open XVim.xcodeproj + 4. Got to Edit Scheme... => Run => Executable => Other => Choose The Xcode.app you installed to. + 5. Run (CMD + R) + +### Run Unit Tests + 1. In your .xvimrc, add a line "set debug", which tells XVim to run in debug mode. + 2. Open XVim.xcodeproj, a debug instance of Xcode shows up. + 3. In the debug Xcode instance, create a random small disposable project (say HelloWorld.xcodeproj) if you have don't this already. + 4. Open HelloWorld.xcodeproj using debug Xcode instance. + 5. Go to XVim menu, there should be an item "test categories" + 6. Choose a category to run + 7. A separate window shows up and unit tests are run inside that window. + 8. Results will be shown when all the tests in that category are completed. diff --git a/README.md b/README.md index fe2bd8a6..ae219229 100644 --- a/README.md +++ b/README.md @@ -65,48 +65,8 @@ Delete the following directory: https://www.bountysource.com/teams/xvim -## Bug issue handling - - Reported bugs are handled following order. - - 1. Confirm if the bug reproduce and the issue labeled as 'Bug' - 2. Fix the bug in 'develop' branch - 3. Confirm the fix by the reporter - 4. The issue is labeled 'Done' - 5. Confirm that the fix does not make another side effect. - 6. Merged into 'master' - 7. The issue is closed. - - This order is only applied to 'Bug' issues. - -## Contributions - Any suggestions, bug reports or feature requests are welcome. - - If you want to add a feature or fix bugs by yourself the following videos are good help for you. - - [How to get debug log](http://www.youtube.com/watch?v=50Bhu8setlc) - - [How to debug XVim](http://www.youtube.com/watch?v=AbC6f86VW9A) - - [How to write a test case](http://www.youtube.com/watch?v=kn-kkRTtRcE) - - Any pull requests are very much appreciated. Before you make a pull request see [Make a Pull Request](Documents/Developers/PullRequest.md) - -Watch the videos mentioned earlier for a full tutorial on developing, debugging and testing XVim. Here is a very simple guide to get you started. - -### Debugging - 1. Make sure you have Xcode.app installed at /Applications/Xcode.app, if that's true just open XVim.xcodeproj and Run (CMD + R). You can ignore the rest steps. - 2. If you have Xcode installed at a different path, follow these steps. - 3. Open XVim.xcodeproj - 4. Got to Edit Scheme... => Run => Executable => Other => Choose The Xcode.app you installed to. - 5. Run (CMD + R) - -### Run Unit Tests - 1. In your .xvimrc, add a line "set debug", which tells XVim to run in debug mode. - 2. Open XVim.xcodeproj, a debug instance of Xcode shows up. - 3. In the debug Xcode instance, create a random small disposable project (say HelloWorld.xcodeproj) if you have don't this already. - 4. Open HelloWorld.xcodeproj using debug Xcode instance. - 5. Go to XVim menu, there should be an item "test categories" - 6. Choose a category to run - 7. A separate window shows up and unit tests are run inside that window. - 8. Results will be shown when all the tests in that category are completed. +## Contributing Guidelines + See separate [CONTRIBUTING.md](.github/CONTRIBUTING.md) ## Donations If you think the plugin is useful, please donate. From 1c5165bb34779fc741e0aaf4096a01c222fd392f Mon Sep 17 00:00:00 2001 From: JugglerShu Date: Tue, 1 Mar 2016 00:21:29 +0900 Subject: [PATCH 3/7] Craete PULL REQUEST TEMPLATE --- .github/PULL_REQUEST_TEMPLATE.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 12e169fd..e6a63098 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,2 +1,11 @@ + \ No newline at end of file From 937e8f9977885701bc429406d2f1d584625bb9a1 Mon Sep 17 00:00:00 2001 From: JugglerShu Date: Sat, 2 Apr 2016 02:41:53 +0900 Subject: [PATCH 4/7] Update ISSUE_TEMPLATE.md --- .github/ISSUE_TEMPLATE.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index a33e99aa..e9472c53 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,7 +1,11 @@ # Description From 8ee2844ebaab4c7d159df13dccf7cb971e433925 Mon Sep 17 00:00:00 2001 From: JugglerShu Date: Sat, 2 Apr 2016 02:50:13 +0900 Subject: [PATCH 5/7] Update README.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae219229..b6a77038 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,29 @@ ## INSTALL Download source code or clone the repo. Then, + + 1. Confirm `xcode-select` points to your Xcode + ```bash + $ xcode-select -p + /Applications/Xcode.app/Contents/Developer + ``` + + If this doesn't show your Xcode application path, use `xcode-select -s` to set. + + 2. make ```bash $ make ``` - Create `.xvimrc` as you need and restart your Xcode. + + If you see something like + + ``` + XVim hasn't confirmed the compatibility with your Xcode, Version X.X + Do you want to compile XVim with support Xcode Version X.X at your own risk? + ``` + Press y if you want to use XVim with your Xcode version (even it is not confirmed it works) + + 3. Create `.xvimrc` as you need and restart your Xcode. ## Branches and Releases XVim has several branches and releases. Usually you only need to download one of 'releases' and use it. From 89e1e9afdef4e40a5d50f806e21b8a9cae8a323a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Wei=C3=9F?= Date: Tue, 5 Apr 2016 16:54:21 +0200 Subject: [PATCH 6/7] Fixing indentation. --- Tools/xcodedump.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Tools/xcodedump.rb b/Tools/xcodedump.rb index ca91f688..15eb6bb8 100755 --- a/Tools/xcodedump.rb +++ b/Tools/xcodedump.rb @@ -23,7 +23,7 @@ def list_frameworks(directory, rel_dir, &block) elsif is_framework(path) block.call(path, rel_dir) elsif File.directory?(path) - list_frameworks(path, rel_dir + "/" + x, &block) + list_frameworks(path, rel_dir + "/" + x, &block) end } end From add2e6d85ba82d5ce07dd4cecf675f72a4f658c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Wei=C3=9F?= Date: Tue, 5 Apr 2016 16:55:10 +0200 Subject: [PATCH 7/7] =?UTF-8?q?Improving=20filtering.=20We=20don=E2=80=99t?= =?UTF-8?q?=20need=20headers=20for=20the=20SDK=20and=20app=20binaries.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Tools/xcodedump.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Tools/xcodedump.rb b/Tools/xcodedump.rb index 15eb6bb8..2bfc41e0 100755 --- a/Tools/xcodedump.rb +++ b/Tools/xcodedump.rb @@ -22,7 +22,7 @@ def list_frameworks(directory, rel_dir, &block) next elsif is_framework(path) block.call(path, rel_dir) - elsif File.directory?(path) + elsif File.directory?(path) and !(/\.platform$/ =~ path or /\.app$/ =~ path) list_frameworks(path, rel_dir + "/" + x, &block) end }