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

Maintenance: simplify local development setup #426

Closed
saragerion opened this issue Jan 6, 2022 · 2 comments
Closed

Maintenance: simplify local development setup #426

saragerion opened this issue Jan 6, 2022 · 2 comments
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation

Comments

@saragerion
Copy link
Contributor

saragerion commented Jan 6, 2022

Description of the feature request

Right now developers who want to contribute to the repository need to run a number of commands to get the project up and running.
We should simplify this situation by creating a number of scripts that can setup the local environment with all the necessary tasks "with just one command" run in your terminal, and that's it.
I believe the Python repo has already something similar.

Problem statement

The lack of such solution is currently making the onboarding process of new contributors rather painful for folks who are new to the repository and especially new to the TypeScript and Node.js ecosystem.

Summary of the feature

Create a script that does all the necessary installations and lerna bootstrap.

Code examples

N/A

Benefits for you and the wider AWS community

Easier onboarding of new contributors.

Describe alternatives you've considered

Makefile
Bash scripts

Additional context

N/A

Related issues, RFCs

#115
#422

@saragerion saragerion added triage This item has not been triaged by a maintainer, please wait all labels Jan 6, 2022
@michaelbrewer
Copy link
Contributor

A makefile can have a low onboarding ie: make dev pr would install all dev dependencies (which could include dev tools or check requirements and install pre-commit hooks) and prepare for a pull request.

Otherwise something like this would be handy using yarn too.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 8, 2022

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@dreamorosi dreamorosi removed the triage This item has not been triaged by a maintainer, please wait label Oct 19, 2022
@dreamorosi dreamorosi changed the title All: simplify local development setup Maintenance: simplify local development setup Nov 14, 2022
@dreamorosi dreamorosi added documentation Improvements or additions to documentation completed This item is complete and has been merged/shipped labels Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants