Create CONTRIBUTING.md file

MisanthropicBit · Jun 1, 2024 · 4ec16b9 · 4ec16b9
1 parent 392aecf
commit 4ec16b9
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+# Contributing
+
+1. Fork this repository.
+2. Make changes.
+3. Make sure tests and styling checks are passing.
+   * Run tests by running `./tests/run_tests.sh` in the root directory. Running the tests requires [`plenary.nvim`](https://github.com/nvim-lua/plenary.nvim)
+   * Install [stylua](https://github.com/JohnnyMorganz/StyLua) and check styling using `stylua --check lua/ tests/`. Omit `--check` in order to fix styling.
+4. Submit a pull request.
+5. Get it approved.
diff --git a/README.md b/README.md
@@ -156,14 +156,7 @@ winmove.current_mode()
 
 ## Contributing
 
-Contributions are welcome!
-
-1. Fork this repository.
-2. Make sure tests and styling checks are passing.
-  * Run tests by running `./tests/run_tests.sh` in the root directory. Running the tests requires [`plenary.nvim`](https://github.com/nvim-lua/plenary.nvim)
-  * Install [stylua]() and check styling using `stylua --check lua/ tests/`. Omit `--check` in order to fix styling.
-3. Submit a pull request.
-4. Get it approved.
+See [here](/CONTRIBUTING.md).
 
 ## FAQ