aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBraxton Hall2022-10-23 21:04:17 +0000
committerGitHub2022-10-23 21:04:17 +0000
commit5c33ff27d08c7ba8ec572e8db4deb755e2258d30 (patch)
tree649e1abfe5824a48a479fbb2708b64f6c07e9765
parentaf0d8d454eaac9cbe5e04b1120645a578b8e60a4 (diff)
Add a contributing guide
-rw-r--r--README.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/README.md b/README.md
index 95b6684..c0bad6b 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
# fib
-## [`adirar111`](https://github.com/adirar111)
+### [`adirar111`](https://github.com/adirar111)
- [`y86`](./entries/adirar111/y86/fib.ys)
-## [`braxtonhall`](https://github.com/braxtonhall)
+### [`braxtonhall`](https://github.com/braxtonhall)
- [`adam`](./entries/braxtonhall/adam/main.py) (WIP)
- [`express`](./entries/braxtonhall/express/index.js)
- [`homework`](./entries/braxtonhall/homework/fib.cpp)
@@ -11,5 +11,15 @@
<!-- - `smt` compiles to SMT, and the solver gives you the fib sequence -->
<!-- - `imperitive-church` imperitive implementation in the lambda calculus -->
-## [`Metroxe`](https://github.com/Metroxe)
+### [`Metroxe`](https://github.com/Metroxe)
- [`html`](./entries/Metroxe/index.html)
+
+## Contributing
+To contribute just make a PR into the `main` branch!
+
+1. Click `Fork` button in the top right of the GitHub page
+1. Develop your `fib` and push to your fork
+ - Put your `fib` in a directory with your GitHub ID under the [`entries/`](./entries) directory
+1. Click the `Pull requests` tab and then the `New pull request` in your fork
+1. Set the base repo and branch to be `braxtonhall/fib` and `main`
+1. Click `Create pull request`