overhaul contributing based on feedback from evan#393
Merged
rocktavious merged 4 commits intofeature/mcpfrom Apr 16, 2025
Merged
overhaul contributing based on feedback from evan#393rocktavious merged 4 commits intofeature/mcpfrom
rocktavious merged 4 commits intofeature/mcpfrom
Conversation
Contributor
eapache-opslevel
left a comment
eapache-opslevel
left a comment
There was a problem hiding this comment.
A few nits/questions. The only other high-level thing (that I know of) that's missing is a mention of long-running branches in the development workflow?
But already this is a big help, thank you.
rocktavious
commented
Apr 16, 2025
Collaborator
Author
rocktavious
left a comment
rocktavious
left a comment
There was a problem hiding this comment.
Review feedback
eapache-opslevel
approved these changes
Apr 16, 2025
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
2 participants
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.
Resolves #
Problem
The CONTRIBUTING.md was too high level and beginner friendly for more experianced devs. Additionally the document hadn't really been touched since the inception of the CLI
Solution
Rewrite the document for more internal use while still being relevant for external contributors. Add more information around the project architecture, how to get started, what helpers have been added to the repo and generally just have a better flow / structure.
Checklist