Skip to content

Commit

Permalink
docs(contributing): add note about order of entries
Browse files Browse the repository at this point in the history
  • Loading branch information
dkundel committed Oct 3, 2019
1 parent 822975e commit 05c5d29
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,16 @@ A new pixel has to be an object with the following four properties:
- `color`: The color your pixel should have as a hex code (e.g. #ff0000 for red)
- `username`: The GitHub username you'll use to create the pull request

The row for your pixel should be sorted by the y-coordinate first and then by the x-coordinate. If you are unsure about your changes, make the change and run `npm run format:json` and it should sort your pixel into the appropriate position.

The change should look like this:

```diff
{
"data": [
+ { "y": 10, "x": 20, "color": "#FFFF00", "username": "dkundel" },
{ "y": 1, "x": 3, "color": "#F22F46", "username": "<UNCLAIMED>" },
{"y": 1, "x": 3, "color": "#F22F46", "username": "twilio-labs"},
+ { "y": 1, "x": 4, "color": "#FFFF00", "username": "dkundel"},
{"y": 2, "x": 9, "color": "#F22F46", "username": "twilio"},
...
]
}
Expand Down

0 comments on commit 05c5d29

Please sign in to comment.