bbaovanc.com/bbaovanc.com
1
0
Fork 0
mirror of https://github.com/BBaoVanC/bbaovanc.com.git synced 2025-07-03 10:37:29 -05:00
Code Issues Projects Releases Wiki Activity

Update README and CONTRIBUTING and link to bobaforum [skip ci]

Browse Source
This commit is contained in:
BBaoVanC
2022-04-18 03:04:52 -05:00
parent 6ad002b319
commit 0bb3dce6e9
2 changed files with 14 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
CONTRIBUTING.md
View File

@ -1,57 +1,14 @@
# Contributing to bobatheme
## Where to put stuff
## Where to put questions/issues/etc
### 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).
## Writing translations
Translations should aim to get the meaning as close as possible to original
document. The changes in a translation pull request *should*:
- only update one page (multiple pages should be split into separate pull
requests)
- only contain changes for a single new file (no changes unrelated to
translation)
- thoroughly compared to the original text in order to get the same meaning
across
## 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.
Please use the [section on
bobaforum](https://talkyard.bbaovanc.com/top/my-website).
## Building
Just in case you need it.
## Automatic deploy previews with GitHub Actions
My GitHub Actions workflows will automatically build each pull request into a
@ -61,9 +18,10 @@ public deploy preview on demo.bbaovanc.com, and will link it in a comment.
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
1. Make sure you install the latest version of Hugo, or hopefully at least the
`min_version` listed in
[theme.toml](https://github.com/BBaoVanC/bobatheme/blob/master/theme.toml#L11).
Let me know if that minimum version isn't enough and I'll fix it.
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

7
README.md
View File

@ -1,3 +1,10 @@
# bbaovanc.com
My personal website, generated using [Hugo](https://gohugo.io)
## Discussions
Please use the [category on
bobaforum](https://talkyard.bbaovanc.com/top/my-website) for any questions,
issues, ideas, discussions, etc. relating to my website. This should replace the
GitHub Discussions system.