Skip to content

Formatters module documentation.#1019

Draft
clrudolphi wants to merge 1 commit intomainfrom
Formatter_Documentation
Draft

Formatters module documentation.#1019
clrudolphi wants to merge 1 commit intomainfrom
Formatter_Documentation

Conversation

@clrudolphi
Copy link
Contributor

🤔 What's changed?

Adding markdown documentation of the Formatters module as a CONTRIBUTING.md style file.

⚡️ What's your motivation?

Provide sufficient documentation that other Reqnroll developers can maintain and extend the Formatters subsystem.

🏷️ What kind of change is this?

  • 📖 Documentation (improvements without changing code)

♻️ Anything particular you want feedback on?

  • Topic coverage: what topics are missing or too lightly treated?
  • Are the diagrams helpful?
  • What other types of documentation artifacts would be helpful?

📋 Checklist:

  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "[vNext]" section of the CHANGELOG, linking to this pull request & included my GitHub handle to the release contributors list.

This text was originally taken from the template of the Cucumber project, then edited by hand. You can modify the template here.

@clrudolphi
Copy link
Contributor Author

I intend to create a similar set of documentation for the Formatters tests project.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant