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

Release v1.0.0 #256

Merged
merged 3 commits into from
Jan 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

- Nothing yet.

## v1.0.0

### Added

- [#190](https://github.com/SuperGoodSoft/solidus_taxjar/pull/190) Add transaction sync batch show page
Expand Down
32 changes: 14 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ about using the Solidus TaxJar extension after it has been installed.
4. Finally, make sure that the `TAXJAR_API_KEY` environment variable is set to
your TaxJar API key.

### Warning: Installing on production
### Warning: Installing on Production

Before you install this extension in your production environment, **we strongly
recommend that you install and configure a supported ActiveJob backend**.
Expand All @@ -68,20 +68,7 @@ particularly helpful.
[active-job-basics]: https://edgeguides.rubyonrails.org/active_job_basics.html
[active-job-execution]: https://edgeguides.rubyonrails.org/active_job_basics.html#job-execution

## Project Status

<!-- FIXME: Modify the following paragraph for the v1.0 release. -->

This extension is under active development and not yet at a v1.0 release, but
it's currently being used in production by multiple Solidus stores.

Requirements for TaxJar integrations vary as some stores also need reporting,
which isn't provided out of the box by this extension. This is because
individual stores will be using different background job frameworks or runners
(Sidekiq, delayed_job, ActiveJob, etc.) and a reliable integration will rely on
one of these. Because this part of the integration is small, we've chosen to
provide the transaction reporting functionality, but have skipped directly
integrating it.
## Developer Support

If you're having trouble integrating this extension with your store and would
like some assistance, please reach out to Jared via e-mail at [jared@super.gd](mailto:jared@super.gd)
Expand All @@ -104,9 +91,12 @@ that event to your applicaiton.
This extension also supports:

* syncing orders to TaxJar's reporting dashboard
* syncing nexus regions as configured in the connected TaxJar account
* syncing nexus regions as configured in the connected TaxJar account (including
automatic _and_ manual sync)
* connecting your Solidus store's tax categories to TaxJar's tax categories (U.S. tax codes)

**Note that reporting is turned off by default.**

### TaxCalculator

`SuperGood::SolidusTaxjar::TaxCalculator` allows calculating the full tax
Expand Down Expand Up @@ -240,7 +230,13 @@ Developers can configure the following settings in an initializer:

Default value: `false`

### Exception handling
### Taxable Orders

Note that the configuration setting `taxable_order_check` can be customized if
there is specific criteria that make some orders taxable and other orders not
taxable. By default this extension considers all orders taxable.

### Exception Handling

You can configure your own exception handler in an initializer. using the
`exception_handler` configuration point:
Expand Down Expand Up @@ -310,7 +306,7 @@ and `SOLIDUS_BRANCH` environment variables, respectively. See the
The database vendor can also be changed from the default (`sqlite3`) by setting
the `DB` environment variable.

### Testing the extension
### Testing the Extension

When testing your application's integration with this extension you may use its factories.
You can load Solidus core factories along with this extension's factories using this statement:
Expand Down
2 changes: 1 addition & 1 deletion lib/super_good/solidus_taxjar/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module SuperGood
module SolidusTaxjar
VERSION = "0.18.2"
VERSION = "1.0.0"
end
end