Skip to content

document workflow to contribute exercises #20

Description

@lucaferranti

Would be good to have a CONTRIBUTING.md documenting the workflow. Writing it down would also help me clarify the steps to myself.

As a first step, let's focus on practice exercises. My understanding so far

  1. Choose an exercise and update config.json, adding at least the fields name, difficulty, stub. (I am a little surprised configlet cannot do this for me).
  2. run bin/configlet uuid and add the code to the uuid field in config.json
  3. run bin/configlet sync --update --docs --metadata --tests --exercise $(EXERCISE-STUB) to initialize the folder
  4. initialize the folder. This could be done with mason init. The add test/tests.chpl (would be nice to automate with next step)
  5. Looking at problem specifications, add exercises to the tests folder.
  6. write a reference solution in .meta/reference.chpl
  7. from main directory, run bin/test to test the reference solution passes the tests.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions