Commit a2afd9dc authored by Isaac Gouy's avatar Isaac Gouy

wordsmith CONTRIBUTING.md

parent c79046c6
Thank you for your interest in contributing to the benchmarks game!
The programs that we measure have been crowd-sourced, contributed to the project by an ever-changing self-selected group.
We are usually happy to accept better programs.
Contribute source-code for measurement
======================================
Your best chance of having source-code accepted is to provide a missing program:
Although we are usually happy to accept better programs, your best chance of having source-code accepted is to provide a missing program:
- if the only ~regex-redux program for ~Lua is broken, then fix it;
- if the programs only use one core then provide a program that uses multicore.
(Also consider language implementations like: ~Dart, ~Hack, ~Smalltalk, ~TypeScript).
Your best chance of having source-code accepted is to show that the algorithm is comparable to the other programs, using comments for reviewers.
Your best chance of having source-code accepted is to show that the algorithm is comparable to the other programs, by using code comments to explain
Style Guide
-----------
......@@ -23,15 +16,23 @@ Write narrow 80 column programs — someone will try to read on a phone.
You will probably come across people saying that the programs are not idiomatic ("enough"). So read the [description](https://benchmarksgame-team.pages.debian.net/benchmarksgame/description/summary.html) and write your own idiomatic program, without programming tricks.
Testing
-------
Test your program!
------------------
Check that program-output matches expected-output before upload.
Use `diff` to check that whitespace characters match.
`diff` program-output with the output-file provided in the [description](https://benchmarksgame-team.pages.debian.net/benchmarksgame/description/summary.html).
Upload a COMPLETE TESTED source-code file
-----------------------------------------
`diff` program output with the output file provided in the [description](https://benchmarksgame-team.pages.debian.net/benchmarksgame/description/summary.html), to check your program is correct, before you contribute your program.
Open a new [Contribute Source Code](https://salsa.debian.org/benchmarksgame-team/benchmarksgame/issues/new?issuable_template=Contribute Source Code) issue.
Attach your COMPLETE TESTED source-code file.
Contribute
----------
(patch files will not be accepted.)
Please open a new [Contribute Source Code](https://salsa.debian.org/benchmarksgame-team/benchmarksgame/issues/new?issuable_template=Contribute Source Code) issue, and remember to attach your complete tested source-code file.
......@@ -31,7 +31,7 @@ Contribute source-code for measurement
The programs that we measure have been crowd-sourced, contributed to the project by an ever-changing self-selected group.
We are usually happy to accept new programs. If you wish to contribute a better program then please refer to [CONTRIBUTING.md](/CONTRIBUTING.md).
We are usually happy to accept better programs. If you wish to contribute a program then please follow these instructions — [CONTRIBUTING.md](/CONTRIBUTING.md).
Suggestions?
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment