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

Update phrasing in Philosophy statement #285

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

dguardado
Copy link

@dguardado dguardado commented Jul 2, 2021

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:

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

Change the philosophy statement so that its heading more clearly relates to the description
@dguardado
Copy link
Author

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

@joshbuker
Copy link
Member

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 joshbuker added the documentation Improvements or additions to documentation label Jul 2, 2021
@dguardado
Copy link
Author

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.

@joshbuker
Copy link
Member

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! 🙂

@dguardado
Copy link
Author

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants