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

Add doc for creating new adapters #642

Conversation

TheSmartnik
Copy link
Contributor

Following #628

@TheSmartnik
Copy link
Contributor Author

@botandrose I've added WIP doc as you asked me in #628 (comment)

I haven't managed to follow it fully since 2.0.0 is not yet published

@codecov
Copy link

codecov bot commented Apr 7, 2020

Codecov Report

❗ No coverage uploaded for pull request base (master@101aaf1). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             master      #642   +/-   ##
==========================================
  Coverage          ?   100.00%           
==========================================
  Files             ?         4           
  Lines             ?       341           
  Branches          ?         0           
==========================================
  Hits              ?       341           
  Misses            ?         0           
  Partials          ?         0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 101aaf1...57619d6. Read the comment docs.

@botandrose
Copy link
Contributor

@TheSmartnik This is really great! Thank you! I'll be doing some more refactoring and test improvement groundwork in a few PRs over the next few days, and I expect I'll merge this after that. Having a documented baseline for where the ORM adapter interface is right now is going to be extremely useful for evaluating future PRs that attempt to improve it! I'm expecting we can simplify it quite a bit before v2.0.

@TheSmartnik TheSmartnik changed the title [WIP] Add doc for creating new adapters Add doc for creating new adapters Apr 8, 2020
@TheSmartnik
Copy link
Contributor Author

@botandrose awesome, glad you liked it :)

@botandrose botandrose merged commit 9f214a1 into DatabaseCleaner:master Apr 9, 2020
@botandrose
Copy link
Contributor

Thanks again, @TheSmartnik!

Since we're not quite ready for people to actually follow these instructions, I'm going to split this content out into its own file, with a big warning up top saying as much. Once v2.0.0 is out the door, it will be restored to the README.

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