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

📝 docs(README): improve the README file and add a getting started section #41

Merged
merged 1 commit into from
Oct 24, 2022
Merged

📝 docs(README): improve the README file and add a getting started section #41

merged 1 commit into from
Oct 24, 2022

Conversation

gdarchen
Copy link
Contributor

@gdarchen gdarchen commented Oct 19, 2022 •
edited
Loading

🎯 Goal

For now, there was no Getting started section in the README.md file.

In this PR, I improved the README.md file.

🧠 Approach

I added a new Getting started section detailing step by step how to add the ts-migration-companion to a user's project.

I also fixed some typos and refactored a bit the layout of the README.md file.

🧪 Test

  1. Read the README.md file
  2. Ensure there is no typo
  3. Ensure it is exhaustive to add the ts-migration-companion to a user's project

Pro tip:
In the Files changed of this PR, you can view the rich text diff to better compare the Markdown changes.
image

📚 Notion Card

@gdarchen gdarchen added the documentation Improvements or additions to documentation label Oct 19, 2022
@gdarchen gdarchen self-assigned this Oct 19, 2022
jdemangeon
jdemangeon approved these changes Oct 19, 2022
View reviewed changes
Copy link
Contributor

@jdemangeon jdemangeon left a comment

Choose a reason for hiding this comment

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

Perfect 👌

ghoullier
ghoullier approved these changes Oct 21, 2022
View reviewed changes
Copy link
Contributor

@ghoullier ghoullier left a comment

Choose a reason for hiding this comment

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

LGTM

@gdarchen gdarchen merged commit cb7668d into main Oct 24, 2022
@gdarchen gdarchen deleted the docs/improve-readme branch October 24, 2022 08:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jdemangeon jdemangeon jdemangeon approved these changes

@ghoullier ghoullier ghoullier approved these changes

Assignees

@gdarchen gdarchen

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gdarchen @jdemangeon @ghoullier