theoludwig/programming-challenges
theoludwig/programming-challenges
1
1
Fork 0
mirror of https://github.com/theoludwig/programming-challenges.git synced 2024-12-08 00:45:29 +01:00
Code Issues Releases Activity

docs: clarify usage of the project to contribute

Browse Source
This commit is contained in:
Divlo 2021-09-30 13:25:24 +02:00
parent 264da68a20
commit 122e62aee5
No known key found for this signature in database
GPG Key ID: 6F24DA54DA3967CF
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -6,7 +6,7 @@ Thanks a lot for your interest in contributing to **programming-challenges**!
- [Submit a challenge](#submit-a-challenge) - [Submit a challenge](#submit-a-challenge)
- [Submit a solution](#submit-a-solution) - [Submit a solution](#submit-a-solution)
- [Add support for a new language](#add-a-language) - [Add support for a new language](#add-a-programming-language)
- Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...). - Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).
## Submit a challenge ## Submit a challenge
@ -27,14 +27,16 @@ Start writing some code, inside the `solution` file with your favorite programmi
Before submitting the solution, make sure it passes all the tests by running `programming-challenges run test --affected`. Before submitting the solution, make sure it passes all the tests by running `programming-challenges run test --affected`.
## Add a language ## Add a programming language
You can add support for a new language, so you can solve the challenges with even more programming languages! You can add support for a new language, so you can solve the challenges with even more programming languages!
- First create a new folder inside `templates/docker` with the file extension of the new programming language (e.g: `js`, `cpp`, etc.) - First create a new folder inside `templates/docker` with the file extension of the new programming language (e.g: `js`, `cpp`, etc.)
- Inside this new folder create a `Dockerfile`, to compile and execute the solution - Inside this new folder create a `Dockerfile`, to compile and execute the solution
- Create a new template inside `templates/solution` folder with the file extension of the new programming language, with the basic boilerplate to read from `stdin` and print to `stdout` the result - Create a new template inside `templates/solution` folder with the file extension of the new programming language, with the basic boilerplate to read from `stdin` and print to `stdout` the result
- Run the command `programming-challenges generate solution --challenge="<name>" --github-user="<your-github-user>" --language="<your-new-language>" --solution="<your-solution>` - Every programming language should have at least one working solution for `challenges/hello-world`.
To do so, run the command `programming-challenges generate solution --challenge="hello-world" --github-user="<your-github-user>" --language="<your-new-language>" --solution="function`
Before submitting the new programming language, make sure it passes all the tests by running `programming-challenges run test --affected` Before submitting the new programming language, make sure it passes all the tests by running `programming-challenges run test --affected`

4
README.md
View File

@ -77,10 +77,10 @@ programming-challenges --help
programming-challenges generate challenge --github-user="YourGitHubName" --challenge="challenge-name" programming-challenges generate challenge --github-user="YourGitHubName" --challenge="challenge-name"
# Generate a new solution # Generate a new solution
programming-challenges generate solution --github-user="YourGitHubName" --challenge="hello-world" --solution="solution-name" --language="python" programming-challenges generate solution --github-user="YourGitHubName" --challenge="challenge-name" --solution="function" --language="python"
# Test a solution # Test a solution
programming-challenges run test --challenge="hello-world" --solution="solution-name" --language="python" programming-challenges run test --challenge="challenge-name" --solution="function" --language="python"
``` ```
## 💡 Contributing ## 💡 Contributing