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

docs(readme): clarify contribution guidelines and licensing #10

Merged
merged 1 commit into from
Aug 11, 2023

Conversation

fvsch
Copy link
Contributor

@fvsch fvsch commented Aug 10, 2023

Partial rewrite of the README.md with:

  • Add main heading and fix heading hierarchy.
  • Language tweaks (use for example instead of e.g., use instead of utilize, etc.)
  • Naming convention: I used the phrase “starter templates” consistently instead of just “starters” because that’s what we’re using in the StackBlitz dashboard. Looking at https://developer.stackblitz.com we are using “starter projects” (most common), “project starters”, and there is one instance of “base template” and one of “starter templates”. Personally I’m not 100% convinced “starter templates” work for us, because we already use the word “template” with a different meaning in our SDK (for the project.template option).
  • Add Contributing section.
  • Add Licensing section.

All those choses are “best guess” efforts, and I’m open to any and all changes.

@fvsch fvsch requested a review from sulco August 10, 2023 12:37
@fvsch fvsch force-pushed the fvsch/update-readme-with-contributing-info branch from ba569d5 to a4d4e02 Compare August 10, 2023 12:38
Copy link
Member

@sulco sulco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the starter templates are good enough for now:)

Great improvements across the board, thank you!

@sulco sulco merged commit 76eaa12 into main Aug 11, 2023
@fvsch fvsch deleted the fvsch/update-readme-with-contributing-info branch November 23, 2023 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants