summaryrefslogtreecommitdiff
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
author2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>2025-08-04 15:40:17 +1000
committer2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>2025-08-04 15:40:17 +1000
commitd8037819f01ef2eb920516ce50237a922019684b (patch)
tree2353531ebe95a7ae69aaa5c77b767a3db7f737d9 /.github/CONTRIBUTING.md
parenttheme: add template system (#36) (diff)
downloadcaelestia-cli-d8037819f01ef2eb920516ce50237a922019684b.tar.gz
caelestia-cli-d8037819f01ef2eb920516ce50237a922019684b.tar.bz2
caelestia-cli-d8037819f01ef2eb920516ce50237a922019684b.zip
ci: add flake update workflow
Also add contributing, funding and issue templates parser: add kill option to shell version: fix errors when not on arch
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..69e7d00
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# Contributing
+
+There are only a few rules:
+- Follow the commit convention as follows:
+ - The name of the commit should be `module: change`
+ - Try to be consistent with the module names; you can look at existing commits for the module names I use
+ - If there is more than one change, the change in the commit name should be the most impactful change
+ - Put other changes in the description
+- Format your code
+ - Just try to follow the code style of the rest of the code and ensure that there is:
+ - no trailing whitespace on any lines
+ - a single space between operators
+- No AI slop allowed
+ - AI readme/docs slop = instant block
+- PLEASE TEST YOUR PRS
+ - I can't believe I have to put this here, but please test your PRs before submitting them
+ - Your PR must not break anything currently existing, or specify in the description if it does
+- PR descriptions should be descriptive
+ - Please explain what the PR does and how to use it in your PR description
+ - Also include any breaking changes and/or side effects of the PR