Skip to content

Commit

Permalink
Update filename note in contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jolaleye committed Apr 27, 2019
1 parent 5a20893 commit e5628eb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Effects are made by adding a Vue component to the `effects/` directory. There ar
3. Use the site's red (`#fc2f70`) & blue (`#3cefff`) theme colors as accents alongside whites, grays, and blacks.
4. Try to match the size of other effects.
5. If an effect requires interaction, make it clear. For example add a hover effect to the word "Hover".
6. Use kebab-case file names prefixed with the effect type (e.g. `loader-ring`). Since effects are collected in alphabetical order, this groups them in the grid.
6. Use kebab-case filenames prefixed with the effect type (e.g. `loader-ring`). The filename prefix identifies effects when the user chooses filters.

> If your editor automatically formats files on save, it may do things like indent the Vue template or replace single quotes with double quotes. These changes can mess with the source code shown in the inspection modal. To avoid this, either temporarily disable formatting or save without formatting (e.g. in VSCode, open the command palette and choose _File: Save without formatting_).
Expand Down

0 comments on commit e5628eb

Please sign in to comment.