Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.38 KB

contributing.md

File metadata and controls

30 lines (20 loc) · 1.38 KB
Raw

Contributing

Love to hear any feedback or tips to improve - submit an issue or a fix via a pull request.

Please ensure you're following the below rules before submitting a PR:

Naming Conventions

Please follow Airbnb's Name Conventions from the style guide.

File Structure & Naming Conventions

  • Structure
    • Follow the existing file structure
  • Files
    • Should be lowercase, with words separated by hyphens (-) eg. logo-cropped.jpg
    • With the exception of Containers and Components, which should be PascalCase - eg. RecipeView.js
  • Directories
    • Folder names should be lowercase, with words separated by a hyphen (-) - eg. /components/case-studies
  • Folders and files can be named singlular or plural - do what sounds right
  • If there's more than a few files in a directory that are related, group them within their own directory
    • eg. if I have 2 components: /components/RecipeListing.js and /components/RecipeView.js, I may choose to create a new directory within components called recipes and put the 2 files within (removing Recipes). The result would be: /components/recipes/Listing.js and /components/recipes/View.js

Linting

Please ensure you're code is passing the built in linter.

Tests

Please include tests with your code and ensure your code is passing the existing tests.