Skip to content

Commit

Permalink
style-change: add recommended commit prefixes
Browse files Browse the repository at this point in the history
The link to the [conventional commits][1] is good, but there are
many ways you can use them.
Therefore, I specified what prefixes I suggest to use in Yafc.

The reasoning behind why exactly there prefixes is that I want them
to be expressive when still not too numerous.

The prefix that might be questionable is `style-change` because
usually we shouldn't change the code style often, but I left it
because, as a developer, I'd not want to miss a code-style change
if I were catching up with the project after some downtime.

[1]: https://www.conventionalcommits.org/en/v1.0.0-beta.2/#summary
  • Loading branch information
shpaass committed Oct 5, 2024
1 parent 10f2a74 commit 68913a9
Show file tree
Hide file tree
Showing 3 changed files with 132 additions and 4 deletions.
10 changes: 9 additions & 1 deletion Docs/CodeStyle.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,16 @@ The main idea is to keep the code maintainable and readable.

### Commits
* Please separate the change of behavior from the refactoring, into different commits. That helps to understand your commits easier.
* Please make meaningful commit messages. We encourage you to use the prefixes from the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#summary). They help to browse the commits later.
* Please update your branch by rebasing, not merging. Merges are expected only when a PR merges into master. In all other cases, they complicate the commit history, so please rebase instead.
* Please make meaningful commit messages.
* Commit-prefixes help to browse the commits later. We encourage you to use the following prefixes in commit subjects:
* `docs` for documentation changes,
* `feature` or `feat` for new features,
* `fix` for bugfixes,
* `refactor` for refactors,
* `style` for the application of the code style,
* `style-change` for the change of the code style,
* `chore` is only for the changes that do not belong to any other prefix.

### Code
* In the programmers' haven, there is always a free spot for those who write tests.
Expand Down
6 changes: 3 additions & 3 deletions Docs/MoreLanguagesSupport.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
YAFC language support is experimental. If your language is missing, that is probably because of one of two reasons:

- It has less than 90% support in official Factorio translation
- It uses non-european glyphs (such as Chinese or Japanese languages)
- It uses non-European glyphs (such as Chinese or Japanese languages)

You can enable support for your language using this method:
- Navigate to `yafc.config` file located at `%localappdata%\YAFC` (`C:\Users\username\AppData\Local\YAFC`). Open it with the text editor.
- find `language` section and replace the value with your language code. Here are examples of language codes:
- Find `language` section and replace the value with your language code. Here are examples of language codes:
- Chinese (Simplified): `zh-CN`
- Chinese (Traditional): `zh-TW`
- Korean: `ko`
- Japanese: `ja`
- Hebrew: `he`
- Else: Look into `Factorio/data/base/locale` folder and find folder with your language.
- If your language have non-european glyphs, you also need to replace fonts: `Yafc/Data/Roboto-Light.ttf` and `Roboto-Regular.ttf` with any fonts that support your language glyphs.
- If your language have non-European glyphs, you also need to replace fonts: `Yafc/Data/Roboto-Light.ttf` and `Roboto-Regular.ttf` with any fonts that support your language glyphs.
120 changes: 120 additions & 0 deletions output.temp
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
change:
change:
chore:
style:
refactor:
docs:
style:
style:
style:
change:
refactor:
feature:
feat:
change:
ci:
docs:
change:
docs:
change:
fix:
refactor:
feature:
refactor:
feature:
docs:
refactor:
release:
docs:
release:
style:
docs:
fix:
refactor:
fix:
refactor:
cli:
chore:
docs:
ci:
docs:
elper:
docs:
md:
rea:
feat:
cleanup:
docs:
feat:
chore:
feat:
chore:
feat:
chore:
refactor:
feature:
fix:
feat:
refactor:
feat:
refactor:
nput:
feat:
fix:
refactor:
fix:
ix:
chore:
ix:
docs:
chore:
docs:
chore:
docs:
docs:
fix:
feat:
docs:
test:
release:
misc:
feat:
chore:
feat:
true:
feat:
true:
feat:
fix:
fix:
docs:
layout:
feat:
perf:
feat:
feat:
docs:
docs:
feat:
feature:
misc:
fixup:
chore:
mics:
fix:
roduct:
feature:
clarity:
true:
refactor:
editorconfig:
its:
feature:
bugfix:
taken:
com:
improvements:
analysis:
com:
xperiments:

0 comments on commit 68913a9

Please sign in to comment.