Skip to content

DOC: consolidate developer docs in main docs #6232

Closed
@jorisvandenbossche

Description

@jorisvandenbossche

There is a new page in the docs 'Contributing to pandas', with at the moment the docs on contributing the documentation. And in #6207 I added already some links to various pages.

At the moment, the information for contributors is a bit scattered:

So maybe we should make a choice where do we want to consolidate the docs:

  • We could opt to put everything in the wiki and CONTRIBUTING.md, so further expanding the wiki.
  • Or put everything in the main docs
  • Or we could try to make a (clear) division:
    • main docs: starting point for newcomers who want to contribute to pandas (how to submit an issue, guidelines for a pull request, basic info on git and building pandas, building the docs, ...)
      • So this would mainly be to somehow merge CONTRIBUTING.md, developer pages on website and contributing page on wiki.
    • wiki: more info for the core developers/regular contributors: some more advanced tips and tricks, release workflow, how to handle the python2/3 issues, which exceptions to raise, ...)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions