Merge pull request #4 from altmshfkgudtjr/dev

Add Contributing guideline & commit template
main
NB 3 years ago committed by GitHub
commit e718a0fd67
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 18
      .gitmessage.txt
  2. 30
      CONTRIBUTING.md
  3. 4
      README.md

@ -0,0 +1,18 @@
# Please write in this format
# <Type> : <Title>
################
# 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
################

@ -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! 😀

@ -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! 😀

Loading…
Cancel
Save