Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 2.68 KB
Raw

Contribution Guidelines

General Guidelines

  1. Respect the formats and categories described below.

  2. Make sure your item is awesome.

    • Only has awesome items. Awesome lists are curations of the best, not everything. — Awesome Guidelines

  3. The item must be added to the bottom of the list.

  4. After your pull request, this list must still be elligible for Awesome.

Formats, naming conventions and descriptions

  • Every item must have the following format : [Item Name](link) - Description., except for the adapter category, which doesn't have descriptions.

  • Every item and description must be in English.

  • Every mention of Inertia.js must use the exact format Inertia.js, except for resource names.

    • ✖ InertiaJS
    • ✖ Inertia
    • ✔ Inertia.js

  • Descriptions should not start with "The", "A", or similar.

    • ✔ Vue.js adapter.
    • ✖ A Vue.js adapter.

  • Descriptions must start with an uppercase character and ends with a period.

  • Descriptions must be short and explicit.

  • Descriptions must describe the resource, not be a slogan.

    • ✔ Showcase of products built with Inertia.js.
    • ✖ The best Inertia.js products.

Categories

Useful Links

This category must contain must-known resources related to Inertia.js, preferably only official ones.

Adapters

This category must contain only Inertia.js adapters that comply to the Inertia.js protocol.

Client-side and server-side adapters must be added to the bottom of their respective sub-categories.

Resources

This category contains other resources directly related to Inertia.js, such as presets or articles. A sub-category can be added if too many related resources are added in the Other sub-category.

The articles sub-category's items must not have a description.

Pull request and commits

You can name your pull request and commits however you want, but for clarity, conventional commits are welcome. Pull request will be squashed upon merge.

Here are the keywords used in this list:

  • add — For adding a resource to the list.
    • add(adapters): Vue.js adapter
  • remove — For removing a resource to the list.
    • remove(item-name): outdated resource
  • update — For updating a resource to the list.
    • update(item-name): fix typographical error in description
  • chore — For anything else.