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

Add a README file to project generator #1390

Open
javiertoledo opened this issue Mar 30, 2023 · 6 comments
Open

Add a README file to project generator #1390

javiertoledo opened this issue Mar 30, 2023 · 6 comments
Assignees
@ironspec07
Labels
dev-experience Developer Experience difficulty: low feature-request New feature or request good first issue Good for newcomers package:cli Affects the CLI package

Comments

@javiertoledo
Copy link
Member

javiertoledo commented Mar 30, 2023 •
edited
Loading

Feature Request

Description

Most frameworks include a README file with default instructions on how to run the project once it's generated.

Possible Solution

Add to the default project template a default README file that includes instructions on how to install, run and test a Booster project.
@javiertoledo javiertoledo added feature-request New feature or request good first issue Good for newcomers package:cli Affects the CLI package dev-experience Developer Experience difficulty: low labels Mar 30, 2023
@yashp4858
Copy link
Contributor

@javiertoledo hey where should I add this instructions on how to install, run and test a Booster project into main readme file of github ?

yashp4858 added a commit to yashp4858/booster that referenced this issue May 30, 2023
@yashp4858
Added a README file to project generator boostercloud#1390
42004d5
@Gingaaa
Copy link

Gingaaa commented Jul 31, 2023

Hey I have worked on around 7-8 company based project, but never countribute to open source, this is my first time can you assign me this task.

@ironspec07
Copy link

can you please assign me this issue @javiertoledo

@NickSeagull
Copy link
Member

Woops, this got lost in the notifications. Any of you is available for this?

I'll assign it to the first one that replies 🙏

@ironspec07
Copy link

Please assign it to me 😀

@NickSeagull
Copy link
Member

Done @ironspec07

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ironspec07 ironspec07

Labels
dev-experience Developer Experience difficulty: low feature-request New feature or request good first issue Good for newcomers package:cli Affects the CLI package
Projects
Booster Framework Roadmap
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
5 participants
@javiertoledo @NickSeagull @yashp4858 @Gingaaa @ironspec07