Skip to content

Commit

Permalink
🎨 Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
econa committed Nov 17, 2016
1 parent 81a5b64 commit c09b167
Show file tree
Hide file tree
Showing 3 changed files with 145 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/CONTRIBUTING.md
@@ -0,0 +1,25 @@
# Contributing to Clipy

:tada: Thank you for contributing to Clipy :tada:

## Styleguides

### Git Commit Messages
- Consider starting the commit message with an applicable emoji:
- 🎨 `:art:` when improving the format/structure of the code
- 🚀 `:rocket:` when improving performance
- 🚱 `:non-potable_water:` when plugging memory leaks
- 📝 `:memo:` when writing docs
- 🍎 `:apple:` when fixing something on macOS or Xcode
- 🐛 `:bug:` when fixing a bug
- 🔥 `:fire:` when removing code or files
- 💚 `:green_heart:` when fixing the CI build
-`:white_check_mark:` when adding tests
- 🔒 `:lock:` when dealing with security
- ⬆️ `:arrow_up:` when upgrading dependencies
- ⬇️ `:arrow_down:` when downgrading dependencies
- 👕 `:shirt:` when removing linter warnings

**If you are using Clipy please use the following snippet.**
- [English version](https://github.com/Clipy/Clipy/blob/master/.github/git_message_en.xml)
- [Japanese version](https://github.com/Clipy/Clipy/blob/master/.github/git_message_ja.xml)
60 changes: 60 additions & 0 deletions .github/git_message_en.xml
@@ -0,0 +1,60 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<folders>
<folder>
<title>Git Commit Messages</title>
<snippets>
<snippet>
<title>🎨 Improvement codes</title>
<content>:art: </content>
</snippet>
<snippet>
<title>🚀 Improvement performance</title>
<content>:rocket: </content>
</snippet>
<snippet>
<title>🚱 Fix memory leak</title>
<content>:non-potable_water: </content>
</snippet>
<snippet>
<title>📝 Write docs</title>
<content>:memo: </content>
</snippet>
<snippet>
<title>🍎 Something on macOS or Xcode</title>
<content>:apple: </content>
</snippet>
<snippet>
<title>🐛 Fix bug</title>
<content>:bug: </content>
</snippet>
<snippet>
<title>🔥 Remove code or files</title>
<content>:fire: </content>
</snippet>
<snippet>
<title>💚 Fix CI build</title>
<content>:green_heart: </content>
</snippet>
<snippet>
<title>✅ Add tests</title>
<content>:white_check_mark: </content>
</snippet>
<snippet>
<title>🔒 Deal with security</title>
<content>:lock: </content>
</snippet>
<snippet>
<title>⬆️ Upgrade dependencies</title>
<content>:arrow_up: </content>
</snippet>
<snippet>
<title>⬇️ Downgrade dependencies</title>
<content>:arrow_down: </content>
</snippet>
<snippet>
<title>👕 Remove lint warning</title>
<content>:shirt: </content>
</snippet>
</snippets>
</folder>
</folders>
60 changes: 60 additions & 0 deletions .github/git_message_ja.xml
@@ -0,0 +1,60 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<folders>
<folder>
<title>Git Commit Messages</title>
<snippets>
<snippet>
<title>🎨 機能やコード追加</title>
<content>:art: </content>
</snippet>
<snippet>
<title>🚀 パフォーマンス改善</title>
<content>:rocket: </content>
</snippet>
<snippet>
<title>🚱 メモリリーク修正</title>
<content>:non-potable_water: </content>
</snippet>
<snippet>
<title>📝 ドキュメント追加</title>
<content>:memo: </content>
</snippet>
<snippet>
<title>🍎 macOSやXcode用の変更</title>
<content>:apple: </content>
</snippet>
<snippet>
<title>🐛 バグ修正</title>
<content>:bug: </content>
</snippet>
<snippet>
<title>🔥 コードやファイル削除</title>
<content>:fire: </content>
</snippet>
<snippet>
<title>💚 CIのビルド修正</title>
<content>:green_heart: </content>
</snippet>
<snippet>
<title>✅ テスト追加</title>
<content>:white_check_mark: </content>
</snippet>
<snippet>
<title>🔒 セキュリティ対処</title>
<content>:lock: </content>
</snippet>
<snippet>
<title>⬆️ ライブラリアップデート</title>
<content>:arrow_up: </content>
</snippet>
<snippet>
<title>⬇️ ライブラリダウングレード</title>
<content>:arrow_down: </content>
</snippet>
<snippet>
<title>👕 Lintの警告を削除</title>
<content>:shirt: </content>
</snippet>
</snippets>
</folder>
</folders>

0 comments on commit c09b167

Please sign in to comment.