Skip to content

Contributor docs are inconsistent with installation docs #1372

@john-sandall

Description

@john-sandall

The contribution guidelines documentation (docs/contribute.md) appears to contain outdated information regarding the development workflow, potentially hindering new contributors.

Context of the issue

The current contribution guidelines documentation needs updating to reflect the actual development practices observed in the repository. Specifically:

  1. Target Branch: The guide (docs/contribute.md, lines 27, 69) instructs contributors to target the dev or development branch for pull requests. However, recent activity suggests main is the active development branch, as dev doesn't seem to exist and development is inactive.
  2. Developer Setup: There's conflicting advice. docs/contribute.md (line 43) advises against installing TPOT for development, while docs/installation.md (Developer/Latest Branch Installation section) recommends pip install -e ..

Clarifying these points will ensure contributors can set up their environment correctly and submit PRs to the appropriate branch.]

Recommendations

Update docs/contribute.md to:

  • Specify main as the target branch for development and PRs.
  • Align the developer setup instructions with docs/installation.md, likely recommending pip install -e . in a suitable virtual environment.
    Remove references to the dev and development branches if they are indeed deprecated.

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