Skip to content

Commit

Permalink
📝 Docs: update contributing file
Browse files Browse the repository at this point in the history
  • Loading branch information
Lruihao committed Jan 16, 2024
1 parent aaebdfb commit dd4f422
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ First, fork this repository by clicking the fork button.
Next, clone your forked repo.

```bash
git clone --recursive https://github.com/hugo-fixit/FixIt.git && cd FixIt
git clone https://github.com/hugo-fixit/FixIt.git && cd FixIt
```

Then, install the dev dependencies.
Expand All @@ -27,6 +27,12 @@ npm run server
npm run server:production
```

If you want to do docs-related theme changes, the simplest way is to have both `FixIt` and `fixit-docs` cloned as sibling directories, and then run:

```bash
npm run server:docs
```

Finally, create a new pull request at <https://github.com/hugo-fixit/FixIt/pulls> to submit your contribution 🎉

## Git standard for developers
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"build": "hugo -v --source=demo --gc --minify",
"server": "hugo server --source=demo -D --disableFastRender --navigateToChanged --ignoreCache --bind 0.0.0.0",
"server:production": "npm run server -- -e production",
"server:docs": "hugo server --source=../fixit-docs -D --disableFastRender --navigateToChanged --ignoreCache --bind 0.0.0.0",
"version": "sed -i '' \"s/v$npm_package_version-RC/v$npm_package_version/g\" layouts/partials/init/index.html && git add .",
"postversion": "git push && git push --tags"
}
Expand Down

1 comment on commit dd4f422

@vercel
Copy link

@vercel vercel bot commented on dd4f422 Jan 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.