-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Kintsugi: Add readme and contributing files. #1
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Contributing | ||
|
||
If you wish to contribute to the project, please follow the guidelines below. | ||
|
||
## Opening issues | ||
|
||
- Check that the issue doesn't exist already. | ||
- Check that the issue was not already fixed in the latest `main`. | ||
|
||
## Pull requests | ||
|
||
**During development** | ||
|
||
- Make sure you're on the latest version to avoid conflicts when opening the pull request. | ||
- Install the needed gems by running `bundle install`. | ||
- Make the changes you need and commit them. | ||
- Add tests for the new functionality. | ||
- Run `bundle exec rake` and make sure all the tests pass. | ||
|
||
**Before opening a pull request:** | ||
|
||
- Squash the commits such that each represents a single coherent change. Make sure that they have [good commit messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
- Open a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
<p align="center"> | ||
<img src="./logo/kintsugi.png" alt="Kintsugi Logo"/> | ||
</p> | ||
|
||
# Kintsugi [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop) | ||
|
||
## What is this? | ||
|
||
One of the frustrations of working with Xcode together with Git is resolving conflicts in Xcode project files, i.e. the `project.pbxproj` file. | ||
|
||
Kintsugi sets out to solve this exact problem: Automatically resolving Git merge conflicts occurring in `.pbxproj` files. | ||
|
||
The end goal is for the tool to succeed 99.9% of the time, and let you resolve the real conflicts in a convenient way the rest of the time. | ||
|
||
> Kintsugi (金継ぎ) is the art of repairing broken pottery by mending it with gold. [Wikipedia](http://en.wikipedia.org/wiki/Kintsugi) | ||
|
||
## How? | ||
|
||
Kintsugi understands the changes you've made to the `.pbxproj` file, so it simply resets the conflicts and re-applies those changes to it. | ||
|
||
From a technical perspective, Kintsugi heavily relies on [Xcodeproj](https://github.com/CocoaPods/Xcodeproj). It uses its diff capability to extract the changes, and uses its project files editing capabilities to apply the changes. | ||
|
||
## Installing Kintsugi | ||
|
||
```sh | ||
$ gem install kintsugi | ||
``` | ||
|
||
If you prefer to use bundler, add the following line to your Gemfile: | ||
|
||
```rb | ||
gem 'kintsugi', require: false | ||
``` | ||
|
||
## Usage | ||
|
||
When there's a `.pbxproj` file with Git conflicts, run `kintsugi <path_to_pbxproj_file>`. | ||
|
||
And see the magic happen! :sparkles: | ||
|
||
## Contribution | ||
|
||
See our [Contribution guidelines](./CONTRIBUTING.md). | ||
|
||
## Alternatives | ||
|
||
- [XcodeGen](https://github.com/yonaskolb/XcodeGen): You can commit this JSON file into Git instead of the `.pbxproj` file. Then resolving conflicts is much easier. | ||
|
||
## Copyright | ||
|
||
Copyright (c) 2021 Lightricks. See [LICENSE](./LICENSE) for details. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
think about adding somewhere here an explanation of what the actual Kintsugi is and a link to https://en.wikipedia.org/wiki/Kintsugi