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

[#56] Improve documentation for v0.2.0 #101

Merged
merged 7 commits into from
Sep 20, 2022

Conversation

chshersh
Copy link
Owner

Resolves #56

I've improved the documentation for tool-sync in a few ways:

  • Rewrote README
  • Added a CHAGELOG
  • Slightly changed the CONTRIBUTING.md guide (now it requires to add new changes in the changelog)
  • Generated a new GIF with the new output
  • Increased the version to 0.2.0

@MitchellBerend @FrancisMurillo @zixuanzhang-x please, double check the CHAGELOG.md file to make sure I haven't introduced any mistakes 🙂

I want to implement #54 and #55 before actually creating a release so the CHANGELOG will change. But those changes shouldn't affect the documentation so this one can be merged separately.

Additional tasks

  • Documentation for changes provided/changed
  • Tests added

@chshersh chshersh added the documentation Improvements or additions to documentation label Sep 19, 2022
@chshersh chshersh self-assigned this Sep 19, 2022
@chshersh
Copy link
Owner Author

Integration testing proved to be very useful!

image

Copy link
Contributor

@zixuan-x zixuan-x left a comment

Choose a reason for hiding this comment

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

LGTM! The README is very informative. Thanks for this documentation update!

CHANGELOG.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@FrancisMurillo FrancisMurillo left a comment

Choose a reason for hiding this comment

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

Looks good.

CHANGELOG.md Outdated Show resolved Hide resolved
@chshersh chshersh force-pushed the chshersh/56-Improve-documentation-for-v020 branch from f877f4c to 8019e56 Compare September 20, 2022 15:49
@chshersh chshersh merged commit 89a7be2 into main Sep 20, 2022
@chshersh chshersh deleted the chshersh/56-Improve-documentation-for-v020 branch September 20, 2022 17:51
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
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation for v0.2.0
4 participants