aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMiquel Sabaté Solà <mikisabate@gmail.com>2024-11-28 11:17:42 +0100
committerMiquel Sabaté Solà <mikisabate@gmail.com>2024-11-28 11:17:42 +0100
commit010888de490ab1fafc0200c37cd09d57a0ff1e9f (patch)
tree559ba6c4f0b906c267c280e6ff90f501aef690bf /CONTRIBUTING.md
parent45fa70a9c9892c980561785db323016e6080177d (diff)
downloadfbos-010888de490ab1fafc0200c37cd09d57a0ff1e9f.tar.gz
fbos-010888de490ab1fafc0200c37cd09d57a0ff1e9f.zip
Replace invalid explanation from contributing.md
I took this file from another project and shamefully forgot to adapt it in a proper way. Now it removes any mentions of NES development and also gives a pointer on using the style from the Linux kernel for git log. Signed-off-by: Miquel Sabaté Solà <mikisabate@gmail.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0baab7f..30e595e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,8 +1,7 @@
## Why?
-Do you want to fix an error you have found? Do you know a way to improve my
-6502-fu or do you know a technique on NES development that might help here? I am
-open for discussion and welcome any help!
+Do you want to fix an error you have found? Do you know a way to improve this
+kernel? I am open for discussion and welcome any help!
## How?
@@ -18,7 +17,9 @@ discussion. For this, mind the following:
Another way is to simply submit a pull request. For this, also mind these:
-- Write a [good commit message](https://chris.beams.io/posts/git-commit/).
+- Write a [good commit message](https://chris.beams.io/posts/git-commit/). Extra
+ points if it's in the style of the [Linux
+ kernel](https://docs.kernel.org/process/submitting-patches.html).
- You are sure that `make` continues to work.
- The pull request has *only* one subject and a clear title. You are not
submitting a pull request with tons of different unrelated commits.