Skip to content

♻️ Improve doc and refactor contribution commands - #1071

Merged
mk-mxp merged 1 commit into
mainfrom
chore/contribution-refoactor-and-documentation
Nov 17, 2026
Merged

mk-mxp merged 1 commit into
mainfrom
chore/contribution-refoactor-and-documentation

Conversation

@homersimpsons

@homersimpsons homersimpsons commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor
  • Rename commands
  • Re-use common logic in commands
  • Merge logic into TestBootstrap command
  • Improve contribution commands documentation
  • Improve main README documentation
  • Properly declare composer format:fix

Part of #1066

Do not hesitate to suggest other documentation improvements. My main goal was to:

  1. Proof read it / refresh it
  2. Make it more dense / easier to read

Comment thread contribution/src/TestGenerator.php Resolved
@homersimpsons
homersimpsons force-pushed the chore/contribution-refoactor-and-documentation branch 3 times, most recently from 673b7c1 to 4b3feb2 Compare November 15, 2026 21:05
Comment thread contribution/src/Command/TestInit.php Resolved
@homersimpsons
homersimpsons force-pushed the chore/contribution-refoactor-and-documentation branch 2 times, most recently from d0c8e64 to 4522470 Compare November 15, 2026 21:09
@homersimpsons
homersimpsons force-pushed the chore/contribution-refoactor-and-documentation branch from 4522470 to b16d15c Compare November 15, 2026 21:17
@homersimpsons homersimpsons mentioned this pull request Nov 15, 2026
6 of 14 tasks

@mk-mxp mk-mxp left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking this forward!

Comment thread contribution/README.md Resolved
Comment thread contribution/README.md Resolved
Comment thread README.md Resolved
@mk-mxp mk-mxp added x:action/improve Improve existing functionality/content x:knowledge/advanced Comprehensive Exercism knowledge required x:module/generator Work on Exercise generators x:type/coding Write code that is not student-facing content (e.g. test-runners, generators, but not exercises) x:size/medium Medium amount of work x:rep/medium Medium amount of reputation labels Nov 16, 2026
- Rename commands
- Re-use common logic in commands
- Merge logic into `TestBootstrap` command
- Improve contribution commands documentation
- Improve main README documentation
- Properly declare `composer format:fix`
@homersimpsons
homersimpsons force-pushed the chore/contribution-refoactor-and-documentation branch from b16d15c to c21dc77 Compare November 17, 2026 12:25

@mk-mxp mk-mxp left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready for the next improvement step!

@mk-mxp
mk-mxp merged commit 9443d5c into main Nov 17, 2026
17 of 18 checks passed
@mk-mxp
mk-mxp deleted the chore/contribution-refoactor-and-documentation branch November 17, 2026 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

x:action/improve Improve existing functionality/content x:knowledge/advanced Comprehensive Exercism knowledge required x:module/generator Work on Exercise generators x:rep/medium Medium amount of reputation x:size/medium Medium amount of work x:type/coding Write code that is not student-facing content (e.g. test-runners, generators, but not exercises)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants