From 25d03e4711d484f84fce32521a39aa36ab8aacef Mon Sep 17 00:00:00 2001 From: Nicholas Tindle Date: Mon, 29 Nov 2021 16:48:46 -0600 Subject: [PATCH] Move Code Reviewers from Wiki into the book (#946) * Add code Reviewers chapter * Add code reviews to summary * add code reviews to how to contribute * Update contents/code_reviews/code_reviewers.md Co-authored-by: Dimitri Belopopsky * Update contents/code_reviews/code_reviewers.md Co-authored-by: Dimitri Belopopsky * Update contents/code_reviews/code_reviewers.md Co-authored-by: Dimitri Belopopsky * Update contents/code_reviews/code_reviewers.md Co-authored-by: Dimitri Belopopsky * Apply suggestions from code review Co-authored-by: Dimitri Belopopsky * Update contents/code_reviews/code_reviewers.md Co-authored-by: Sammy Plat * Update contents/code_reviews/code_reviewers.md Co-authored-by: Sammy Plat * Update contents/code_reviews/code_reviewers.md * Update contents/code_reviews/code_reviewers.md * Update contents/code_reviews/code_reviewers.md Co-authored-by: Dimitri Belopopsky Co-authored-by: Sammy Plat --- SUMMARY.md | 1 + contents/code_reviews/code_reviewers.md | 69 +++++++++++++++++++ .../how_to_contribute/how_to_contribute.md | 4 +- 3 files changed, 73 insertions(+), 1 deletion(-) create mode 100644 contents/code_reviews/code_reviewers.md diff --git a/SUMMARY.md b/SUMMARY.md index e41ba39d4..4d4597b1c 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -3,6 +3,7 @@ * [Algorithm Archive](README.md) * [Introduction](contents/introduction/introduction.md) * [How To Contribute](contents/how_to_contribute/how_to_contribute.md) + * [Code Reviewers](contents/code_reviews/code_reviewers.md) * [Plotting](contents/plotting/plotting.md) * [Domain Coloring](contents/domain_coloring/domain_coloring.md) * [Iterated Function Systems](contents/IFS/IFS.md) diff --git a/contents/code_reviews/code_reviewers.md b/contents/code_reviews/code_reviewers.md new file mode 100644 index 000000000..0061ab996 --- /dev/null +++ b/contents/code_reviews/code_reviewers.md @@ -0,0 +1,69 @@ +# Code Reviewers + +If you are comfortable reviewing a language, please add yourself to the table below: + +[//]: # (To add yourself to the table, please add a link at the bottom of the article and reference yourself in the following format next to each language [@username]. If there are multiple usernames for a language, make sure to seperate them with commas) + +Language | Reviewers +-|- +asm-x64 | +bash | +c | [@amaras] +c# | +clojure | +coconut | [@amaras] +c++ | [@ShadowMitia] +crystal | +D | +dart | +elm | +emojicode | +factor | +fortran | [@leios] +gnuplot | [@leios] +go | +haskell | +java | +javascript | [@ntindle],[@ShadowMitia] +julia | [@leios] +kotlin | +labview | +lolcode | +lisp | +lua | +matlab | +nim | +ocaml | [@ShadowMitia] +php | +piet | +powershell | +python | [@ntindle],[@ShadowMitia],[@amaras],[@PeanutbutterWarrior] +r | +racket | +ruby | +rust | [@ShadowMitia],[@PeanutbutterWarrior] +scala | +scheme | +scratch | [@leios] +smalltask | +swift | +typescript | [@ntindle] +v | +viml | +whitespace | + +If you are comfortable reviewing a toolchain change, please add yourself to the list below: + +Feature | Reviewers +-|- +Dev Container | [@ntindle], [@ShadowMitia] +Docker | [@ntindle], [@ShadowMitia] +Github Actions | [@ntindle] +Honkit | +Scons | [@amaras],[@PeanutbutterWarrior] +Chapters | [@leios] + +[@leios]: https://github.com/leios +[@ntindle]: https://github.com/ntindle +[@amaras]: https://github.com/amaras +[@ShadowMitia]: https://github.com/ShadowMitia diff --git a/contents/how_to_contribute/how_to_contribute.md b/contents/how_to_contribute/how_to_contribute.md index 010bc9a26..abadc5385 100644 --- a/contents/how_to_contribute/how_to_contribute.md +++ b/contents/how_to_contribute/how_to_contribute.md @@ -15,7 +15,9 @@ For now, here are the basics for submitting code to the Algorithm Archive: 3. **CONTRIBUTORS.md**: After contributing code, please echo your name to the end of `CONTRIBUTORS.md` with `echo "- name" >> CONTRIBUTORS.md`. 4. **Building the Algorithm Archive**: Before every submission, you should build the Algorithm Archive on your own machine. To do this, install [Node](https://nodejs.org/) and use `npm install` and then `npm run serve` in the main directory (where `README.md` is). This will provide a local URL to go to to view the archive in your browser of choice. Use this server to make sure your version of the Algorithm Archive works cleanly for the chapter you are updating! -To submit code, simply go to the `code/` directory of whatever chapter you want and add another directory for your language of choice. +To **submit code**, go to the `code/` directory of whatever chapter you want and add another directory for your language of choice. + +You can also help out by **reviewing code**, if you have the ability to review a language (and want to be asked to do so), please add yourself to [the Code Reviewers list](../code_reviews/code_reviewers.md) We use two GitBook plugins to allow users to flip between languages on different algorithms. One is the theme-api, and the other is the include-codeblock api.