diff --git a/docs/default.nix b/docs/default.nix index 6f5737b..5b524cc 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -45,7 +45,6 @@ in pkgs.stdenvNoCC.mkDerivation { cp ${../README.md} src/README.md cp ${../gnome.png} src/gnome.png cp ${../kde.png} src/kde.png - cp ${../CONTRIBUTING.md} src/contributing.md # mdBook doesn't support this Markdown extension yet substituteInPlace **/*.md \ diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 0218179..cf475f1 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -13,7 +13,7 @@ # Contributing -- [Contributing](contributing.md) +- [Commit Convention](commit_convention.md) - [Adding modules](modules.md) - [Testbeds](testbeds.md) - [Style guide](styling.md) diff --git a/CONTRIBUTING.md b/docs/src/commit_convention.md similarity index 96% rename from CONTRIBUTING.md rename to docs/src/commit_convention.md index 83db828..3b0ed81 100644 --- a/CONTRIBUTING.md +++ b/docs/src/commit_convention.md @@ -1,6 +1,4 @@ -# Contributing to Stylix - -## Commit messages +# Commit Convention To keep things consistent, commit messages should follow a format [similar to Nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#commit-conventions): @@ -31,7 +29,7 @@ punctuation. Most commits to `master` will also include a pull request number in brackets after the summary. GitHub adds this automatically when creating a squash merge. -### Old commits +## Old commits Commits before 2024 did not follow any particular format. Some have emojis from [GitMoji](https://gitmoji.dev).