Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (38 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

64 lines (38 loc) · 3.51 KB

How to contribute to the Exercism Factor track

Do you want to add an exercise?

  • Ensure that someone else isn't already adding it by searching the forum and the repository's issues and pull requests.

  • If nobody is yet adding the exercise, open a conversation and indicate you'd like to add the exercise.

  • Examplar solutions must only use words taught in their introduction.md, or taught by their transitive dependencies. This is enforced by the "Learning checks" workflow.

  • Follow the Add a Practice Exercise docs, and use

bin/add-practice-exercise <exercise-slug>
  • Each uuid is generated using
bin/configlet uuid
  • An exercise should include a .meta/tests.toml file if, and only if, the exercise has a canonical-data.json in problem-specifications.

Do you want to verify an exercise's example solution?

  • Use bin/verify-exercises to check that an exercise's example/exemplar solution passes its tests:
bin/verify-exercises <exercise-slug>   # omit the slug to verify every exercise
  • If factor is not on your PATH, point the FACTOR environment variable at the executable, e.g. FACTOR=/path/to/factor bin/verify-exercises <exercise-slug>.

Do you want to report a bug?

  • Ensure the bug was not already reported by searching the forum.

  • If you're unable to find an open conversation addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and (when possible) a code sample.

Do you want to fix a bug?

  • Ensure that the bug is reported. Only start fixing the bug when there is agreement on whether (and how) it should be fixed.

  • Fix the bug and submit a Pull Request to this repository.

  • Ensure the PR description clearly describes the problem and solution. Include a link to the bug's corresponding forum conversation.

  • Before submitting, please read the Contributors Pull Request Guide and Pull Request Guide.

Do you intend to add a new feature or change an existing one?

  • Ensure that the feature or change is discussed on the forum. Only start adding the feature or change when there is agreement on whether (and how) it should be added or changed.

  • Add the feature or change and submit a Pull Request to this repository.

  • Ensure the PR description clearly describes the problem and solution. Include a link to the bug's corresponding forum conversation.

  • Before submitting, please read the Contributors Pull Request Guide and Pull Request Guide.