Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 2.56 KB

readme.md

File metadata and controls

55 lines (36 loc) · 2.56 KB
Raw

hexbin

a community curated list of hexagon logos

submit a hexagon

  • first, make sure you're the owner of the hexagon you are submitting!
  • clone this repo
  • add your hexagon to the hexagons/ folder in dimensions 181x209 as a png.
  • add the vector version vector/ folder in either svg or adobe illustrator format with the same filename as the previous step. please make sure this is 500kb or less
  • add a new .json file in meta/ with the metadata for your hexagon. use this template:
{
  "name": "dat",
  "author": "max ogden",
  "license": "CC0",
  "raster": "http://hexb.in/hexagons/dat.png",
  "vector": "http://hexb.in/vector/dat.svg",
  "description": "this is optional!",
  "order_online_url": "this is optional. should be a link to where people can buy the sticker online"
}

make sure name only has lowercase letters, numbers and hyphens

then make a pull request to this repo. bonus points if you embed your hexagon image in your pull request description!

here is an example of a great PR: max-mapper#5

Note

You do not need to rebuild the site in your PR, in fact this makes merges more complicated for maintainers. Please let the maintainers handle rebuilding after merges.

for maintainers

after merging PRs/adding new hexes you have to build the site:

  • npm run build
  • commit + add
  • git push origin gh-pages

So the general workflow I'd suggest is to start with the oldest PRs first and work towards the newer ones.

Usually I click the 'Files changed' tab to look at what files they touched. If they followed the directions it should only touch files in hexagons/, meta/, and vectors/.

If github lets me I then hit the green 'Merge pull request' button on github and move to the next one.

I basically repeat this process for all the straightforward PRs. If you get one that changes other files beyond those 3 folders or otherwise looks weird, ignore it for now.

After merging them all you have to clone/pull the gh-pages branch (there is no master branch only gh-pages on this repo), git pull origin gh-pages. To push you do git push origin gh-pages.

After pulling, run npm run build. This should build a new data.json file. You can run npm start to start a local test server to visually inspect if the page looks ok. If it does, you can push.

OK for the weird ones, you can simply comment like how DanFinlay does and point out the weird stuff they did. If you're feeling generous you can just merge it anyway and then go in manually and fix their files after in a new commit, rebuild and push a fixed version.