Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.41 KB

README.md

File metadata and controls

47 lines (31 loc) · 2.41 KB
Raw

Project icon — a tilted 3x3x3 icon

Unofficial Cubing

Results from unofficial events at WCA competitions.

Contributing

Do you have results from a competition that is not listed?

Each competition consists of files placed in data/competitions/[competition-id]:

  • A competition-info.json file like this.
  • One file at round-results/[event-name]-round[number].csv per round, formatted like this:
rank,wcaID,name,average,best,attempt1,attempt2,attempt3,attempt4,attempt5
1,2014PAST01,Dan Pastushkov,18.50,15.70,18.88,15.70,18.39,19.15,18.22
2,2017BRYA06,Aedan Bryant,21.83,18.81,26.02,21.55,24.57,18.81,19.36
3,2016JERO01,Charles Jerome,22.79,19.21,22.05,1:02.55,21.47,19.21,24.86
…

Feel free to send a pull request or file an issue with data that can be converted into this format.

Project maintenance

Accepting contributions

  1. If the data is not in pull request format, create a pull request matching the format of other competitions.
  2. If you or the contributor were not directly involved in organizing the relevant competition results, verify the results with someone who was.
  3. Ensure there is a competition-info.json file for the competition, and a .csv file corresponding to each specified round.
  4. Check that CI is passing (green checkmark) and generating all the appropriate rounds. For example, you can see that make build was able to generate all the competitions here.
  5. Approve the pull request and merge it.

Once the pull request is merged into main, CI will run one more time and then build and deploy the website automatically.

Adding a competition stub using the commandline

If you have bun installed, you can add a competition stub using:

bun install
bun run script/add-competition.ts -- SomeCompetition2023 fto magic

Then add the appropriate CSV files and push to a branch using git to make a pull request.