Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (59 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

79 lines (59 loc) · 3.03 KB
Raw

Contributing

Thanks for considering it. This repository is the TablePro marketing site, and the most valuable contributions to it are usually not code.

What is most useful

  • Blog posts. Practical writing about working with databases on macOS.
  • Comparison pages. If you have switched to or from another client and can describe the difference accurately, that is worth more than any feature we could add to this page.
  • Database landing pages. One per database engine. Accuracy matters more than length.
  • Copy fixes. Wrong claims, stale version numbers, awkward sentences.
  • Accessibility and responsive fixes.
  • Translations. Open an issue first so we can agree on the routing.

Ground rules for content

The site claims things about a real product that real people pay for, so:

  • Do not claim a feature TablePro does not have.
  • Do not describe a competitor inaccurately. If you are comparing, be fair: a comparison page that oversells us is worse than no page.
  • Cite a version when a claim depends on one.

Development

composer install && npm install
cp .env.example .env && php artisan key:generate
composer dev

No database, no API keys. If something asks you for either, that is a bug.

Before opening a pull request:

vendor/bin/pint     # code style
php artisan test    # test suite
npm run build       # make sure the bundle still builds

CI runs the same three. It will not fix style for you.

What does not belong here

Anything touching licenses, payments, customer accounts or personal data is handled by a separate application. See docs/architecture.md. If your change needs one of those, open an issue describing what you need rather than working around it.

Licensing

By contributing you agree that:

  • Code you contribute is licensed under the MIT license.
  • Content you contribute (prose, blog posts, page copy) is licensed under CC BY-NC 4.0.

Practically: anyone may reuse the code freely, and may share the writing with attribution for non-commercial purposes. Nobody may take the writing and product screenshots and stand up a competing commercial site with them.

Do not commit images you do not have the rights to. Third-party logos under public/images/sponsors/ belong to their owners and are used with permission; neither license above extends to them. The TablePro logo files under public/images/brand/ and the site icons (public/logo.png, public/images/logo.png, public/apple-touch-icon.png and public/favicon.ico) are trademarks, not covered by either license. The brand guidelines text is CC BY 4.0. After the app icon changes, regenerate the PNG files in public/images/brand/ with scripts/brand-kit.sh <path to a TablePro app checkout> (macOS, needs rsvg-convert from librsvg).

resources/data/integrations.json and public/images/integrations/ are copied from TableProApp/integrations under its terms. The next sync replaces them. Change an entry there.