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.

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

Add better instructions for running connect #172

Open
fbwoolf opened this issue Oct 11, 2021 · 5 comments
Open

Add better instructions for running connect #172

fbwoolf opened this issue Oct 11, 2021 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@fbwoolf
Copy link
Contributor

fbwoolf commented Oct 11, 2021

It has been reported that devs had a hard time understanding how to run/test making changes to connect. We should added better instructions for how this works best using yalc.

@markmhendrickson
Copy link
Contributor

Might this be best handled by documentation / migrated to that repo?

@fbwoolf
Copy link
Contributor Author

fbwoolf commented Oct 11, 2021

Might this be best handled by documentation / migrated to that repo?

Not sure on this? I do think we need better readme instructions for these repos, but it would be great to get some more information about Connect in the docs.

@markmhendrickson
Copy link
Contributor

@pgray-hiro thoughts here on where this sort of content may go best, and who should produce?

@pgray-hiro
Copy link
Contributor

For the case that is raised by this issue (i.e. developer wants to locally run the connect development environment so that they can contribute features to the connect library), I think updating the README is the most relevant. At minimum there should be instructions on the prerequisites for developing against the connect repo, how to clone and build the library locally, and how to run any unit tests locally. This content needs to come from whoever is maintaining the repo, which introduces a resourcing challenge.

Separately it would be nice to move this repo into the Stacks.js repo, but I don't believe it's a pre-requisite for resolving this issue, because the README would also migrate, and it still needs expanded content.

@markmhendrickson markmhendrickson added documentation Improvements or additions to documentation and removed enhancement labels Oct 13, 2021
@dartman10
Copy link

+1

@smcclellan smcclellan added icebox and removed icebox labels Jul 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 📋 Backlog
Development

No branches or pull requests

5 participants