improve decorators / contributing docs #2933
Merged
Conversation
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
Otherwise people coming from the website will be confused about where the doc sources are hosted. The link now points to the README inside guides/, to which this commit adds an introductory paragraph with further guidance.
Using `prepend self` avoids repetition and potential errors coming from copy/paste. Reducing the module nesting makes it less prone to mis-referencing constants by skipping the namespace, requiring a the qualified reference to be used instead.
ericsaupe
approved these changes
Nov 6, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A couple of fixes to docs. I'd also like to address this comment:
but I need to know if there's any plan to do that or what would be the desired new home for the decorators docs.
My proposal would be something like Local Changes or Patching, which would work for both the general application using Solidus directly and the extension developer adding functionality.
Also if there's any collective wisdom to share, would be great to add some guidance on how to patch templates (erb/jbuilder/ecc.) 😄.