Skip to content
This repository has been archived by the owner on Sep 20, 2018. It is now read-only.

Make placeholders configurable #10

Merged
merged 18 commits into from
Jul 1, 2015
Merged

Make placeholders configurable #10

merged 18 commits into from
Jul 1, 2015

Conversation

bkeepers
Copy link
Contributor

The Code of Conduct will gain more adoption if it's easy for maintainers to adopt it. Some projects may still want to fork it and make more drastic changes, but for a significant portion of the community, the standard template will suffice. This is an attempt to demonstrate what was suggested in #7:

configure

Updated gif, here is the original

If we want to go this route, there's still some more work to do here:

  • Clean up the JavaScript
  • Design it
  • ZeroClipboard to make it easier to copy the snippet
  • Better way to encode config data

What do you think?

/cc @caniszczyk

@mislav
Copy link

mislav commented Jun 29, 2015

I'm a fan of how this was executed. 👍

I'm not a fan, though, of the user's perspective: how this generates URLs that seem to have robot barf in it. URLs with big fragment values that carry important data generally don't fill me with confidence.

@bkeepers
Copy link
Contributor Author

I agree. Here are a few ideas to make this better:

  • use normal params: ?community=Foobar&email=abuse@example.com
  • continue using the anchor, but make it cleaner: #Foobar,abuse@example.com

@bkeepers
Copy link
Contributor Author

I made a few tweaks to the design. It could use a real designer at some point, but this highlights what I was envisioning.

GIF

@bkeepers
Copy link
Contributor Author

@mislav I updated this to use this url format: http://opencodeofconduct.com/#ProjectName/email%40example.com. Thoughts?

@mislav
Copy link

mislav commented Jun 30, 2015

Looks great (both design and URL path).

Even if query parameters in the URL are human-readable, I think seeing them betrays that this text has been auto-generated and that might make the CoC feel less personalized and less legit. I'm just speaking for myself here.

@mislav
Copy link

mislav commented Jun 30, 2015

Here's how to copy contents of a <input> element without Flash in Chrome 43+ and Firefox 41+:

input.select()
document.execCommand('copy')
window.getSelection().removeAllRanges()

@bkeepers
Copy link
Contributor Author

Alright, I'm pretty happy with where this is at. I would love feedback or suggestions on what else is needed. There are some changes I need to push to the todogroup.org styles to make this work, but I'll get a PR open for that so we can merge both at the same time.

/cc @caniszczyk @amateurhuman @mislav

configure

@mislav
Copy link

mislav commented Jun 30, 2015

If you're going to have magic copy behavior, you have to make the users know. Otherwise they probably won't figure it out by themselves. Maybe it's best to have an explicit “Copy to clipboard” button.

@caniszczyk
Copy link
Member

Hell I actually like it! I think it's good enough to start with, we can iterate later and making it a bit fancier. Some people will use this functionality, others will simply copy the index.md

* origin/gh-pages:
  Incorporate changes from Amy and the Geek Feminism CoC
  Fix simple typo in index.md
bkeepers added a commit that referenced this pull request Jul 1, 2015
Make placeholders configurable
@bkeepers bkeepers merged commit 20dfe36 into gh-pages Jul 1, 2015
@bkeepers bkeepers deleted the configurable branch July 1, 2015 02:11
@bkeepers
Copy link
Contributor Author

bkeepers commented Jul 1, 2015

@mislav thanks for all your feedback. It's live: http://todogroup.org/opencodeofconduct/

One thing I think we'll want to tweak is the snippet that gets copy and pasted into the project. Since tons of projects will have this, we'll want to make sure it's well-worded:

This project adheres to the Open Code of Conduct. By participating, you are expected to uphold this code.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants