sorcery icon indicating copy to clipboard operation
sorcery copied to clipboard

Update phrasing in Philosophy statement

Open dguardado opened this issue 3 years ago • 5 comments

Change the philosophy statement so that its heading more clearly relates to the description.

For context, it wasn't clear to me what exactly the "Magic vs Voodoo" comment was trying to say, but it definitely did not communicate to me that the lib would be easy to work on. In the worst reading, I think the comment is unnecessarily disparaging of a real religion and spiritual practice of African origin. The change in this PR is a suggestion that I think communicates the intent more clearly based on the contents of the rest of the line, but if a different change resonates better with your intent y'all are probably the experts on that.

Thanks for your consideration!

Please ensure your pull request includes the following:

  • [x] Description of changes
  • [x] Update to CHANGELOG.md with short description and link to pull request
  • [X] Changes have related RSpec tests that ensure functionality does not break (N/A)

dguardado avatar Jul 02 '21 16:07 dguardado

I'd also like to apply this change to the wiki once approved.

dguardado avatar Jul 02 '21 16:07 dguardado

I definitely agree that "Magic yes, voodoo no" is pretty unclear on what it actually means, and can be changed to something a little more clear.

I don't know that "Approachable and Accessible" fully fits the ease of modification philosophy, but I do think that would be an appropriate philosophy to enumerate, be that in a new bullet point, or by wordsmithing something that covers both the library being approachable for newcomers and easy to modify to fit a developers needs.

Perhaps we could change it to "Magically easy to modify", and add a new point for the approachability aspect for newcomers? Would love to hear ideas.

joshbuker avatar Jul 02 '21 17:07 joshbuker

Perhaps we could change it to "Magically easy to modify", and add a new point for the approachability aspect for newcomers?

This sounds good to me! I didn't necessarily mean to add anything new to the Philosophy but I also think "approachable to newcomers" is a great thing to value and would be a positive addition if that resonates with you :)

I'm happy to make those changes, or let me know how best to proceed.

dguardado avatar Jul 02 '21 18:07 dguardado

What would be most helpful from my perspective is if you could brainstorm some various options and post them on this PR as a new comment.

I could then put some thought into what fits best with the library philosophies, and how Sorcery fits into the greater Ruby ecosystem, then consolidate it into an updated "Philosophy" section.

Thanks! :slightly_smiling_face:

joshbuker avatar Jul 02 '21 18:07 joshbuker

Sounds good! Here are a few options I came up with to pair with the text "the lib should be easy to hack for most developers":

  • "Easy to modify"
  • "Adaptable"
  • "Adjustable"
  • "Developer friendly"
  • "Powerful but familiar" (maybe getting at the feeling of the lib doing a lot for you while still being understandable)
  • "Magic yes, Arcane no" (same as above, but keeps the magic wordplay)

I think the bottom half of the list could also be a good fit to cover both "ease of modification" and "approachable to newcomers". Let me know what you think!

dguardado avatar Jul 03 '21 16:07 dguardado