From 132cccfb649430d2e509b02e3ac269e8888b092a Mon Sep 17 00:00:00 2001 From: BBaoVanC Date: Sat, 16 Oct 2021 00:22:28 -0500 Subject: [PATCH] Add CONTRIBUTING.md and update bobatheme --- .gitattributes | 1 + CONTRIBUTING.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++ themes/bobatheme | 2 +- 3 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/.gitattributes b/.gitattributes index 6942a4f..3660118 100644 --- a/.gitattributes +++ b/.gitattributes @@ -3,4 +3,5 @@ *.css linguist-detectable=true *.js linguist-detectable=true README.md linguist-detectable=false +CONTRIBUTING.md linguist-detectable=false docs/** linguist-detectable=false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6643193 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# Contributing to bobatheme + +## Where to put stuff + +### Discussions + +The best place to ask questions or have discussions is the (relatively new) +discussions feature on GitHub, available +[here](https://github.com/BBaoVanC/bbaovanc.com/discussions). It's not too big +of an issue though because discussions and issues can easily be converted +between eachother. + +### Issues + +Issues should be used only for, well, issues. Ignore all the placeholder ones +prefixed with "Translate:" and tagged with the "translation" tag as they are +placeholders used in the projects tab. I might mark them as closed in the future +to clean it up but I'll worry about that later. + +## Translations + +Discussion relating to translations should either go as comments or reviews on +the pull request adding the translation, or as a discussion under the +[Translations category](https://github.com/BBaoVanC/bbaovanc.com/discussions/categories/translations). + +## Pull requests + +### Commit messages + +It's not too big of a deal what you put in your commit messages, but try to give +each commit a rough description of what it changes. I'll use squash merges most +of the time anyways. + +### Description + +If the pull request doesn't require any extra information in addition to the +title, you can probably leave the description blank. Otherwise you can put some +information, just try to keep it concise; it's better to read a couple sentences +than an entire essay with the same amount of information. + +## Building + +## Automatic deploy previews with Netlify + +Netlify will automatically build each pull request into a public deploy preview, +and will link it in a comment. + +## Manual (local) building + +You can also build the site yourself using Hugo, including a live local preview. + +1. Make sure you install the latest version of Hugo, or at least the + `min_version` listed in + [theme.toml](https://github.com/BBaoVanC/bobatheme/blob/master/theme.toml#L11). +2. Clone the repo +3. Make sure to download and checkout the submodules (use `git submodule update + --init --recursive`). The `--recursive` flag is especially important because + bobatheme has a submodule in itself for icons. +4. Run `hugo serve -D` to run a local webserver. Hugo will show the URL you can + access the preview at. It will automatically rebuild and reload pages when + you save them. diff --git a/themes/bobatheme b/themes/bobatheme index 2ceda80..2fe1ef4 160000 --- a/themes/bobatheme +++ b/themes/bobatheme @@ -1 +1 @@ -Subproject commit 2ceda80f74ebbae6d5398826e46fe2d7edd6be61 +Subproject commit 2fe1ef449fd318fc879999eab64d8f8a41016897