Skip to content

[Enhancement]: Documentation / Content formatting improvement #399

@adarsh-priydarshi-5646

Description

@adarsh-priydarshi-5646

Type of Enhancement

Clarification/Rewording (e.g., making text clearer, simplifying language)

Relevant Page(s) URL (if applicable)

https://discover-cookbook.numfocus.org/14_how_to_contribute.html

Current Content Snippet (Optional, but helpful)

Proposed Enhancement / Suggestion

  • Update the heading to # How to Contribute for clarity and standardization.
  • Improve readability by breaking long sentences into shorter lines.
  • Remove the unnecessary extra dash in the bullet list.
  • Ensure the feedback section is consistent with other bullet points.

Revised text:

How to Contribute

NumFOCUS invites the community to make suggestions for improvements to the DISCOVER Cookbook via pull request (PR). PRs will be evaluated by the NumFOCUS DISC Committee and/or its volunteers. PRs should be written so as to conform to the NumFOCUS Contributor Code of Conduct. You can also open an issue to suggest an update.

If you find this cookbook useful, please support NumFOCUS and our work in these ways:

Rationale & Expected Impact

This enhancement improves clarity, readability, and formatting consistency.

  • It removes redundant formatting (extra dash).
  • It makes instructions easier to follow.
  • It aligns the section with NumFOCUS documentation standards.

Impact: 🍎 (easy, high impact) – Simple formatting changes that improve user experience significantly.

Additional Resources / Further Reading

https://www.numfocus.org/about/code-of-conduct
https://github.com/numfocus/DISCOVER-Cookbook

Contribution

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