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

Review and update documentation #773

Merged
merged 38 commits into from
Mar 22, 2021
Merged

Conversation

Vitalina-Vakulchyk
Copy link
Contributor

@Vitalina-Vakulchyk Vitalina-Vakulchyk commented Mar 16, 2021

In the main README.md:

  • there are no leftovers like deprecated/removed features descriptions;
  • add a “Getting Started” section, containing an example with the most basic usage of the gem;
  • add information which versions of AR are supported by each major Chewy release;
  • explain how Elasticsearch client options is passed to the Elasticseach::Client.new
  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Added an entry to the changelog if the new code introduces user-observable changes. See changelog entry format for details.

Copy link
Contributor

@dalthon dalthon 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.

I just left a suggestion that you could ignore because I think it might be a matter of taste

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@bbatsov
Copy link
Member

bbatsov commented Mar 16, 2021

One goal to have in mind - make sure the documentation features all the information you'd like to see there as a newcomer to the project. That's our bar for success. :-)

Copy link
Contributor

@AlexVPopov AlexVPopov left a comment

Choose a reason for hiding this comment

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

Hey @Vitalina-Vakulchyk, I'll do a couple of additions later today and ping you. :-)

README.md Outdated Show resolved Hide resolved
@Vitalina-Vakulchyk
Copy link
Contributor Author

@toptal-anvil ping reviewers

Copy link
Member

@bbatsov bbatsov 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!

@AlexVPopov AlexVPopov merged commit c25a153 into master Mar 22, 2021
@AlexVPopov AlexVPopov deleted the review-and-update-documentation branch March 22, 2021 07:17
@rabotyaga rabotyaga restored the review-and-update-documentation branch March 22, 2021 08:05
rabotyaga pushed a commit that referenced this pull request Mar 22, 2021
@rabotyaga rabotyaga deleted the review-and-update-documentation branch March 22, 2021 08:10
cyucelen pushed a commit to cyucelen/chewy that referenced this pull request Jan 28, 2023
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.

4 participants