CONTRIBUTING.md

Contributing Guide

• Find Similar Issues or Pull Requests
• Develop
• Create Commit and Push
• Open Pull Request
• Update Local Repository

Find Similar Issues or Pull Requests

Nothing? Then, open a new issue first, and discuss problems or proposals.

Develop

# (1) Fork this repository on GitHub.

# (2) Clone your fork repository to your local.
git clone https://github.com/<username>/hugo-theme-iris.git
cd ./hugo-theme-iris

# (3) Start Hugo Server with Docker.
make up

Create Commit and Push

git checkout -b feat-something-option
vim ./path/to/files
git add ./path/to/files
git commit -m "feat: Add something option"
git push origin feat-something-option

Open Pull Request

On Github.

Update Local Repository

git remote add upstream https://github.com/peaceiris/hugo-theme-iris.git
git checkout main
git pull upstream main