From 6cf7d0ae27be8bd6bf3ea51338faa5a83f506e56 Mon Sep 17 00:00:00 2001 From: KernelDeimos Date: Fri, 23 Aug 2024 15:09:25 -0400 Subject: [PATCH] doc: update CONTRIBUTING.md --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++---------- 1 file changed, 29 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b28814b4..40a50189 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,25 +57,44 @@ See [doc/contributors/index.md](./doc/contributors/index.md) for more informatio
+## PR Standards + +We expect the following from pull requests (it makes things easier): +- If you're closing an issue, please reference that issue in the PR description +- Avoid whitespace changes +- No regressions for "appspace" (Puter apps) + +
+ ## Commit Messages -Use the imperative, as is the convention in the Linux kernel: +**Note:** we will squash-merge some PRs so they follow . Large PRs should follow conventional commits also. The instructions below are outdated but suitable for most PRs. -- correct: `Improve performance of readdir` -- incorrect: `Improved readdir` -- incorrect: `Improving readdir` +### Conventional Commits +We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) with the following prefixes: +- `fix:` for bug fixes +- `dev:` instead of `refactor:`; covers more basis +- `tweak:` for small updates +- `sync:` when updating data from another source +- `feat:` for a commit that first introduces a new feature + +Commit messages after the prefix should use the imperative (the same convention used in the repo for Linux, which Git was built for): + +- correct: `dev: improve performance of readdir` +- incorrect: `dev: improved readdir` +- incorrect: `dev: improving readdir` We have the following exceptions to this rule: - If the commit message is in _past tense_, it's a shorthand for the following: - - `Apply changes that would be applied after one had ` + - `dev: apply changes that would be applied after one had ` - If the commit message is in _present tense_, it's shorthand for the following: - - `Apply changes that would be applied after ` + - `dev: apply changes that would be applied after ` For example, the following are correct: -- `Improved readdir` - - interpret this as: `Apply changes that would be applied after one had improved readdir` -- `Improving readdir` - - interpret this as: `Apply changes that would be applied after improving readdir` +- `dev: improved readdir` + - interpret this as: `dev: apply changes that would be applied after one had improved readdir` +- `dev: improving readdir` + - interpret this as: `dev: apply changes that would be applied after improving readdir`