Skip to content

[Doc]: consolidate coding guidelines  #26095

Closed
@story645

Description

@story645

Documentation Link

https://matplotlib.org/devdocs/devel/contributing.html#coding-guidelines

Problem

There is both a coding guidelines section in contribute and a whole separate page of coding guidelines that used to be a pull request guide:

They're kind of repeating and referencing each other in a way where contributors should probably be reading both but they're not really cross linked. For example, the adding new API section of each:
image
image

Suggested improvement

I think the coding guidelines section of the contributing guide should be merged into the coding_guide page and I'd pull the PR checklists back out into their own page. I'd rather merge than cross link because I think "one source of truth"/"one place to update" is more maintainable than trying to keep all the links in sync.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions