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

improve contribution documentation #28

Merged
merged 3 commits into from
Sep 12, 2023
Merged

Conversation

anmarchenko
Copy link
Member

What does this PR do?

  • Documents test matrix
  • Documents how to work with appraisals

Motivation
Improving edveloper experience

@codecov-commenter
Copy link

codecov-commenter commented Sep 12, 2023

Codecov Report

Merging #28 (ac9fc63) into main (d6067d6) will not change coverage.
Report is 4 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #28   +/-   ##
=======================================
  Coverage   98.94%   98.94%           
=======================================
  Files          83       83           
  Lines        2563     2563           
  Branches       98       98           
=======================================
  Hits         2536     2536           
  Misses         27       27           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more


```bash
# This would only install dependencies for `rspec` group definition
APPRAISAL_GROUP=rspec bundle exec appraisal install
Copy link
Contributor

@TonyCTHsu TonyCTHsu Sep 12, 2023

Choose a reason for hiding this comment

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

I think rspec is not a good example, because it is declared from the Gemfile at the project root.
Perhaps using cucumber would be a better example.

Copy link
Member Author

Choose a reason for hiding this comment

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

true, will replace with cucumber

@anmarchenko anmarchenko added this to the 0.1.0 milestone Sep 12, 2023
@anmarchenko anmarchenko merged commit c027f59 into main Sep 12, 2023
18 checks passed
@anmarchenko anmarchenko deleted the anmarchenko/improve_docs branch September 12, 2023 12:23
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.

3 participants