Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (38 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 1.95 KB

Contributing

How do I add a solution for a given day?

  1. Pop some popcorn 🍿 (or whatever you enjoy 🍭 🍾 🥛 🍷 🍹 🍫 🍺)
  2. Fork
  3. Write a solution, in the language of your choice. Example: vim 2020/day03/solutions/my-solution.py
  4. Test your solution
$ ./lang/python.sh "2020/day03/solutions/my-solution.py" "2020/day03/io/my.input 2020/day03/io/my.output"

# ..or use this short-hand
$ ./lang/python.sh "2020/day03/solutions/my-solution.py" "2020/day03/io/*"

cat INPUT | python3  my-solution.py          13ms       ✅

  1. Make sure 2020/day03/test.sh tests your solution.

  2. To test the whole day do:

./2020/day03/test.sh

# or test in docker container
make name=2020/day03
  1. When you are happy with local testing, make a Pull Request to the main branch.
  2. One of the maintainers will merge PR's, at the of each day.
  3. Remember to have fun 🎉

How do I add a language?

  1. Add the language you want to the Dockerfile
  2. Add a language test-script in lang/<new-language>.sh
  3. Add an example solution in examples/solutions/example.<new-language>
  4. Make a PR to main-branch.
  5. One of the maintainers will push a new docker-image to dockerhub.com, based on your PR.
  6. ...then make sure Github workflows uses the new docker-image.
  7. ...then merge the PR.

How are solutions tested?

Every solution gets the io/*.input-files for a given day delivered to stdin, using cat. Whatever is written to stdout by the solution, is then compared for equality against io/*.output-files, using diff. This is identical for every language.

Example:

#!/usr/bin/env bash
cat day03/io/my.input | <solution-in-any-language> | diff - day03/io/my.output

See examples/solutions/, for examples on how to read from stdin and how to write to stdout in different languages.