Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 2.23 KB

contributing.md

File metadata and controls

41 lines (28 loc) · 2.23 KB
Raw

Contribution Guidelines

Kindly adhere to our Contributor Code of Conduct while participating in this project.

Making New Entries

The list is built on entries so we love getting suggestions for the best.

Choosing the entry

  • Ask yourself: is this really a great example or resource for local-first? If so, we want it!

Formatting the entry:

  • Each entry should follow the format: [Title in Title Case](link) - Description.
  • Add new entries at the bottom of the relevant section.
  • Maintain concise, accurate descriptions without Local-First mentions or ambiguous language.
  • Start descriptions with a capital and end with a full stop/period.
  • Avoid starting descriptions with A or An.
  • Double-check spelling and grammar before submitting.

Making the pull request:

  • Give the Pull Request the name: Add [Title of Entry in Title Case]
  • Do not open Draft / WIP pull requests; ensure it's fully ready and compliant.
  • If you're submitting something you have made, wait at least 30 days after creation before submitting it.
  • Make separate pull requests for each addition.

We appreciate your suggestions!

Contributing to the Awesome List

To contribute, follow these steps:

  1. Get a GitHub account.
  2. Visit the Awesome Local-First GitHub page.
  3. Click on the readme.md file: Step 2 Click on Readme.md
  4. Click on the edit icon. Step 3 - Click on Edit
  5. Edit the file in the in-browser editor, following the guidelines and using GitHub Flavored Markdown. Step 4 - Edit the file
  6. State your reasons for the proposed changes and click "Propose file change". Step 5 - Propose Changes
  7. Submit the pull request!