docs: add contribution guide to README.md (#12)

DonIsaac · Nov 4, 2024 · 02b501f · 02b501f
1 parent 529bcb1
commit 02b501f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,8 @@
 # Contributing
 
+Thanks for your interest in contributing to ZLint! This document outlines how to
+set up your development environment and contribution guidelines.
+
 ## Setup
 
 You'll obviously need to have [Zig](https://ziglang.org/) installed. Right now
@@ -44,6 +47,7 @@ brew install entr
 ```
 
 ## Building, Testing, etc.
+
 Run `just` (with no arguments) to see a full list of available tasks.
 
 ## Conventions

diff --git a/README.md b/README.md
@@ -3,3 +3,11 @@
 An opinionated linter for the Zig programming language.
 
 This project is still very much under construction.
+
+## Contributing
+
+If you have any rule ideas, please add them to the [rule ideas
+board](https://github.com/DonIsaac/zlint/issues/3).
+
+Interested in contributing code? Check out the [contributing
+guide](CONTRIBUTING.md).