Kintsugi: Add readme and contributing files. #1
Conversation
README.md
Outdated
| ## Installing Kintsugi | ||
|
|
||
| ```sh | ||
| $ [sudo] gem install kintsugi |
There was a problem hiding this comment.
I'd remove sudo, I think it confuses more than it helps
README.md
Outdated
|
|
||
| ## Alternatives | ||
|
|
||
| - [XcodeGen](https://github.com/yonaskolb/XcodeGen): You can check in this JSON file instead of the `.pbxproj` file. Then resolving conflicts is much easier. |
There was a problem hiding this comment.
You can check in this JSON file
who can check what?
There was a problem hiding this comment.
Check into the source control. Updated wording.
CONTRIBUTING.md
Outdated
|
|
||
| ## Pull requests | ||
|
|
||
| **First time** |
There was a problem hiding this comment.
First time making a pull request? Running the project? this is unclear. Also, if they haven't forked our repo I don't think they can open a PR so this is a bit redundant.
I would assume people know how to fork a repo and make a pull request so I think you can remove this.**
| <img src="./logo/kintsugi.png" alt="Kintsugi Logo"/> | ||
| </p> | ||
|
|
||
| # Kintsugi [](https://github.com/rubocop/rubocop) |
There was a problem hiding this comment.
think about adding somewhere here an explanation of what the actual Kintsugi is and a link to https://en.wikipedia.org/wiki/Kintsugi
|
@ashdnazg round done. |
README.md
Outdated
|
|
||
| # Kintsugi [](https://github.com/rubocop/rubocop) | ||
|
|
||
| > Kintsugi (金継ぎ) is the art of repairing broken pottery by mending it with gold. [Wikipedia](http://en.wikipedia.org/wiki/Kintsugi) |
There was a problem hiding this comment.
This is a bit confusing here. I would expect a Kintsugi is a tool for automatically resolving merge conflicts in Xcode project files to be the first sentence in the readme. The etymology should be lower down
byohay
changed the title
No description provided.