You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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.
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.
The text was updated successfully, but these errors were encountered:
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:
docs/contribute.md
, lines 27, 69) instructs contributors to target thedev
ordevelopment
branch for pull requests. However, recent activity suggestsmain
is the active development branch, asdev
doesn't seem to exist anddevelopment
is inactive.docs/contribute.md
(line 43) advises against installing TPOT for development, whiledocs/installation.md
(Developer/Latest Branch Installation section) recommendspip 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:main
as the target branch for development and PRs.docs/installation.md
, likely recommendingpip install -e .
in a suitable virtual environment.Remove references to the
dev
anddevelopment
branches if they are indeed deprecated.The text was updated successfully, but these errors were encountered: