Skip to content

Latest commit

 

History

History
266 lines (192 loc) · 9.76 KB

CONTRIBUTING.md

File metadata and controls

266 lines (192 loc) · 9.76 KB
Raw

How to Contribute

This project is built with NextJS, TypeScript, and Material UI. Being a PWA, ideally all tools should work offline without any server side code.

Please do not start working on something until you have an issue assigned to you. If you see an issue you want to work on, please add a comment asking for it to be assigned to you. If there is no issue, please create one first and request that it be assigned to you. Following this protocol will ensure that nobody wastes their valuable time and effort.

  • Check the open issues.
    • Any issue with the "triage" label is pending review and not ready to be worked on or claimed.
    • Any issue with the "help wanted" label is ready to be claimed, feel free to add a comment requesting that it be assigned to you.
    • Any issue with the "discussion" label is and open discussion, please feel free to add your thoughts.
  • Create a feature request or bug report.

General Guidelines

  • Please base your work on the dev branch, and make sure your pull request is submitted against the dev branch.
  • Write tests for your tool or changes before submitting a PR.
  • Try to match the UI, style, and practices laid out in the existing tools.
  • Prefer automatic execution on text entry over buttons when feasable, unless calculation is computationally expensive.
  • Use useLocalState where appropriate to store values when the user leaves the page. Include the tool name in the local state key to prevent naming collisions.
  • Add copy, paste, and clear buttons where appropriate to make the tools easy to use.
  • Use the Toast component when a button or action does not otherwise indicate that anything happened (e.g. the copy button).
  • Use the useSupportsClipboardRead hook to conditionally show a paste button, this feature is not supported on all browsers.

Getting Started

First, fork this repository on GitHub, and clone your fork to your local machine.

Checkout the dev branch to base your work on:

git checkout dev

Create a branch for your work:

git checkout -b my_branch_name

Set the upstream for your fork:

git push -u origin my_branch_name

Install dependencies:

npm install

Run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Note this project includes a devcontainer configuration, so it's possible to contribute and do development work in both GitHub Codespaces as well as VS Code Dev Containers.

Project Structure

  • Project Root
    • __TESTS__
      • Create a file for testing your tool (required)
    • components
      • Create a directory here for your tool if needed
    • data
      • nav.ts
        • Add your tool to this file to include it in the main navigation
    • hooks
      • Create a directory for your tool if needed, unless it is a generic/re-usable hook
    • i18n
      • Translations, organized by language code
    • pages
      • Create a page for your tool, note that the filename will be used as the page slug
    • styles
      • Create a directory for your tool if needed, but please stick with MUI styles as much as possible

Basic Example

  1. Take a look at some of the existing tools to see what tooling has already been built (e.g. toasts, local storage, window size, etc.)

  2. Create a translation namespace for your tool in i18n/en/myToolName.json, add an entry for any hard-coded text as you work on your tool

    {
  "title": "My Tool Name"
  // ...
}

  3. Add your namespace to i18n.ts

    // ...
import myToolName from '../i18n/en/myToolName.json';

export const resources = {
  en: {
    // ...
    myToolName,
  },
} as const;

  4. Create the file pages/your-tool-slug.tsx

    import React from 'react';
import { Namespace, useTranslation } from 'react-i18next';

import nextI18NextConfig from '../next-i18next.config.js';
import Layout from '../components/Layout';

export default function MyToolName() {
  const { t } = useTranslation('myToolName');

  return (
    <Layout title={t('title')}>{/* TODO - Build my tool */}</Layout>
  );
}

const i18nextNameSpaces: Namespace[] = ['common', 'myToolName'];

export const getStaticProps: GetStaticProps = async ({ locale }) => {
  const translation = await serverSideTranslations(
    locale || 'en',
    i18nextNameSpaces as string[],
    nextI18NextConfig,
  );
  return {
    props: { ...translation },
  };
};

  5. Add your tool name to the common namespace (i18n/en/common.json)

    {
  // ...
  "myToolName": "My Tool Name"
}

  6. Add your tool to the main navigation (data/nav.ts)

    //...
import SomeIcon from '@mui/icons-material/SomeIcon';

export default [
  // ...
  {
    title: 'myToolName', // This is the translation key from the common namespace
    href: '/my-tool-slug',
    Icon: SomeIcon,
  },
];

  7. If you have added or improved a tool, please note it in the changelog (data/changelog.yml), this will be shown on the homepage for 30 days

    #       | Date    | Time   | Timezone (GMT -7 hours in this example)
- date: 2022-10-26T00:00:00-0700
  note: My cool tool added

Code quality

Linting

This project uses husky to run ESLint and Prettier on every commit. If there is an issue in the files you are committing, you may see a message like this:

$ git commit -m "feat: update regex component"

✔ Preparing lint-staged...
❯ Running tasks for staged files...
  ❯ .lintstagedrc — 1 file
    ❯ *.{js,jsx,ts,tsx} — 1 file
      ✖ eslint --fix [FAILED]
      ◼ prettier --write
↓ Skipped because of errors from tasks. [SKIPPED]
✔ Reverting to original state because of errors...
✔ Cleaning up temporary files...

✖ eslint --fix:

/workspaces/developertools.tech/components/regex/RegexTestCase.tsx
  82:3  error  Unexpected console statement  no-console

✖ 1 problem (1 error, 0 warnings)

husky - pre-commit hook exited with code 1 (error)

Fix the highlighted errors, git add your files, and try again. You can manually run ESLint for the entire project with npm run lint.

Tests

You must write tests for your tool or changes before submitting a PR. Running npm test will start Jest in watch mode, allowing you to run only tests related to files changed since the last commit.

You can run all the tests in the project with npm run test:ci. Github Actions will run them for you once you submit your PR, so this is not required.

Note: When writing tests, if you are querying for an input label, or any string that is translated, you'll need to use the translation ID instead of the translated text.

Internationalization (i18n)

This App is internationalized. This section describes the addition of translations.

Check for Missing Translations

You can check for missing translations by running npm run translations:check, which will generate a markdown file missing-translations.md in the root of this project.

Add translation file (namespace)

Translation JSON files should be added to the i18n/{en, ja, ..etc}/{pageName}.json

Import the JSON file in i18n.ts and add it to the resources.en object

Use translation

  1. Add getStaticProps to the page
  2. Utilize the UseTranslation hook
  3. Get translated string values from the t function

Please refer to the base64 tool as an example

Add a language

Adding a language does not require adding every translation for the entire app, missing translations will fall back to english.

  1. See Getting Started to create a fork and a new branch based on the dev branch

  2. Create a directory at i18n/{short-language-code}/, use a language code or LCID string for the directory name

  3. Create the namespace JSON files to match the en directory

    • en/common.json also includes translations for each language (e.g. "en": "English"), these don't need to be translated, as they are already in the native language.
    • Add the new language to en/common.json with the key being short language code, and the value being the name of the language in that language.

  4. Add the translated text to each namespace file

  5. Add the locale language code or LCID string from step 2 to next-i18next.config.js

    module.exports = {
  i18n: {
    // ...
    locales: ['en', 'ja', 'pt-BR', 'YOUR_LOCALE_HERE'],
  },
  // ...
};

  6. Create a pull request against the dev branch on GitHub

More Resources

To learn more about Next.js, take a look at the following resources: