From d20dd0f84653fc5e9ddf17d2ddb7113cbd58055a Mon Sep 17 00:00:00 2001 From: NB <47492535+altmshfkgudtjr@users.noreply.github.com> Date: Sat, 15 May 2021 21:23:56 +0900 Subject: [PATCH 1/4] style : git commit template Add git commit template --- .gitmessage.txt | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .gitmessage.txt diff --git a/.gitmessage.txt b/.gitmessage.txt new file mode 100644 index 0000000..4c7595f --- /dev/null +++ b/.gitmessage.txt @@ -0,0 +1,18 @@ +# Please write in this format +# : + +################ +# Write body + +################ +# Write footer or issue number + +################ +# feature : New feature +# fix : Fix bug +# docs : Fix docs +# test : Mofiy test code +# refactor : Refactoring code +# style : Changes that don't affect code semantics +# chore : Build parts or package manager modifications +################ \ No newline at end of file From fda2f902667fc89cd7a5b30b122753c99452d3eb Mon Sep 17 00:00:00 2001 From: NB <altmshfkgudtjr@naver.com> Date: Sat, 15 May 2021 21:45:25 +0900 Subject: [PATCH 2/4] Create contributing.md --- .github/contributing.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/contributing.md diff --git a/.github/contributing.md b/.github/contributing.md new file mode 100644 index 0000000..01557b2 --- /dev/null +++ b/.github/contributing.md @@ -0,0 +1,30 @@ +# Contributing to React-Epub_Viewer + +🎈 First off, thanks for taking the time to contribute! 🎈 + +The following is a set of guidelines for contributing to `React-Epub_Viewer`, which are hosted by NB. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. + +First open an issue and let us know what you're contributing to! + +--- + +**Table Of Contents** + +[Code Commit](#Code-Commit) + + + +--- + +# Code Commit + +1. Please create a branch in this format, **`<Issue Number>-<Some name>`** +2. Open a terminal and navigate to your project path. And enter this. +**`git config --global commit.template .gitmessage.txt`** +3. You can use the template, with `git commit` through vi. **Not** `git commit -m` +4. Enjoy contributing! + + +--- + +If you have any other opinions, please feel free to suggest! 😀 From 719a5bb4118287367619eecbb2433f78d15558af Mon Sep 17 00:00:00 2001 From: NB <altmshfkgudtjr@naver.com> Date: Sat, 15 May 2021 22:00:16 +0900 Subject: [PATCH 3/4] Rename .github/contributing.md to CONTRIBUTING.md --- .github/contributing.md => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/contributing.md => CONTRIBUTING.md (100%) diff --git a/.github/contributing.md b/CONTRIBUTING.md similarity index 100% rename from .github/contributing.md rename to CONTRIBUTING.md From 643d975783423c3c16ac108d00dce04bc611a822 Mon Sep 17 00:00:00 2001 From: NB <47492535+altmshfkgudtjr@users.noreply.github.com> Date: Sat, 15 May 2021 22:04:39 +0900 Subject: [PATCH 4/4] docs : Add contributing guideline Add contributing guideline --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 22b5878..da1b742 100644 --- a/README.md +++ b/README.md @@ -135,3 +135,7 @@ You can see also Types for React-Epub-Viewer [here](https://github.com/altmshfkg +# Contribuing + +If you would like to contribute, please follow the [guideline](https://github.com/altmshfkgudtjr/react-epub-viewer/blob/main/CONTRIBUTING.md)! Thank you! 😀 +