Create contributing.md

main
NB 3 years ago committed by GitHub
parent d20dd0f846
commit fda2f90266
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 30
      .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! 😀
Loading…
Cancel
Save