-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revise configuration-related docs after PR review
Thanks to adammathys for his review of this content.
- Loading branch information
1 parent
b386e4f
commit 5d4cdc2
Showing
4 changed files
with
64 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Forking Solidus | ||
|
||
If your store requires deep customizations to Solidus's core functionality, you | ||
may want to fork Solidus for your store where you can more freely implement your | ||
features. | ||
|
||
Note that this can complicate your Solidus upgrade process or can break other | ||
Solidus extensions you may wish to use. | ||
|
||
The benefit of using a fork of Solidus is that you can test your new features | ||
with Solidus's test suite and ensure your development has not broken Solidus's | ||
existing functionality. | ||
|
||
You can reference a fork of Solidus in your `Gemfile` this way: | ||
|
||
```ruby | ||
gem 'solidus', git: 'https://github.com/my_account/solidus.git', branch: "my-new-feature" | ||
``` | ||
|
||
If you think your feature (or fix) is of interest to the wider Solidus | ||
community, [consider making a pull request][contributing]. | ||
|
||
[contributing]: https://github.com/solidusio/solidus/blob/master/CONTRIBUTING.md | ||
|
||
## Create a "private fork" | ||
|
||
If your organization needs to work in a private repository for any reason, | ||
forking Solidus becomes slightly more complicated. GitHub does not allow you to | ||
create private forks of public repositories. Instead, you can duplicate the | ||
repository. See GitHub's [Duplicating a repository][duplicating] article for | ||
more information. | ||
|
||
[duplicating]: https://help.github.com/articles/duplicating-a-repository/ |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters