Skip to content

Contributor docs are inconsistent with installation docs #1372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
john-sandall opened this issue Apr 17, 2025 · 0 comments · May be fixed by #1373
Open

Contributor docs are inconsistent with installation docs #1372

john-sandall opened this issue Apr 17, 2025 · 0 comments · May be fixed by #1373

Comments

@john-sandall
Copy link

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.
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 a pull request may close this issue.

1 participant