Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Code quality/project standards alignment #218

Open
5 tasks
woodruffw opened this issue Aug 30, 2023 · 0 comments
Open
5 tasks

Code quality/project standards alignment #218

woodruffw opened this issue Aug 30, 2023 · 0 comments
Labels
not-an-issue

Comments

@woodruffw
Copy link

This is a meta-issue, intended to track sub-issues that will align Medusa's codebase, development practices, etc. with the rest of our public tooling.

  • Align README.md with our doc practices
  • Streamline our installation steps
    • Move developer-specific installation instructions to their own CONTRIBUTING.md (this file already exists, but doesn't explain how to get a development environment stood up)
    • Provide a "single-step" install flow so that users don't have to manually download binaries from GitHub Releases
  • Add some kind of QUICKSTART.md or similar guide

(This list is not intended to be exhaustive, and will be updated over time!)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
not-an-issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@woodruffw @anishnaik