docs: Update contribution guide for main branch workflow#1373
Merged
jay-m-dev merged 1 commit intoEpistasisLab:mainfrom Jul 3, 2025
Merged
docs: Update contribution guide for main branch workflow#1373jay-m-dev merged 1 commit intoEpistasisLab:mainfrom
jay-m-dev merged 1 commit intoEpistasisLab:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
This PR assumes the development workflow no longer uses the
developmentbranch as it does not exist. It is noted that https://github.com/EpistasisLab/tpot2/tree/dev does exist but the last commit is 7 months old i.e. older than https://github.com/EpistasisLab/tpot2/tree/main ... if this assumption is incorrect and thedevelopmentbranch will be reinstated, then this PR can be updated accordingly. The section aroundpip install -e .may still apply.What does this PR do?
This PR updates the contribution guidelines (
docs/contribute.md) to reflect the assumed development workflow which seems to use themainbranch for both stable releases and active development. It removes references to the deprecateddevanddevelopmentbranches and clarifies the developer setup process, directing users to the developer installation instructions.Where should the reviewer start?
Review the changes in
docs/contribute.md.How should this PR be tested?
Read through the updated
docs/contribute.mdto ensure the instructions are clear, accurate, and reflect the current repository practices (targetingmain, usingpip install -e .for setup).Any background context you want to provide?
The previous guidelines referred to
dev/developmentbranches which are no longer active, and contained conflicting information regarding the developer environment setup. This led to confusion for potential contributors.What are the relevant issues?
Closes #1372
Questions: