Contribution Guidelines

import "github.com/pkg/errors"

func readFile(path string) error {
    data, err := os.ReadFile(path)
    if err != nil {
        return errors.Wrap(err, "failed to read file")
    }
    return nil
}

import "google.golang.org/grpc/status"

if memo == nil {
    return nil, status.Errorf(codes.NotFound, "memo not found")
}

// Good
package store

type Driver interface {
    CreateMemo(ctx context.Context, memo *Memo) (*Memo, error)
}

const MaxMemoSize = 1024 * 1024

// Bad
package Store // Wrong: uppercase package

const MAX_MEMO_SIZE = 1024 * 1024 // Wrong: snake_case

// CreateMemo creates a new memo in the database.
// It returns an error if the user does not exist.
func (s *Store) CreateMemo(ctx context.Context, memo *Memo) (*Memo, error) {
    // ...
}

import (
    "context"
    "fmt"

    "github.com/pkg/errors"
    "google.golang.org/grpc/codes"

    "github.com/usememos/memos/store"
)

goimports -w .

interface MemoCardProps {
  memo: Memo;
  onDelete?: (id: number) => void;
}

export const MemoCard: React.FC<MemoCardProps> = ({ memo, onDelete }) => {
  const handleDelete = useCallback(() => {
    onDelete?.(memo.id);
  }, [memo.id, onDelete]);

  return (
    <div className="memo-card">
      {/* ... */}
    </div>
  );
};

// Server state - use React Query
import { useMemos } from '@/hooks/useMemoQueries';

const { data: memos } = useMemos({ userId: user.id });

// Client state - use Context
import { useAuth } from '@/contexts/AuthContext';

const { user } = useAuth();

// Local state - useState
const [isOpen, setIsOpen] = useState(false);

<div className="flex items-center gap-2 rounded-lg bg-gray-100 p-4 dark:bg-gray-800">
  {/* content */}
</div>

import { cn } from '@/lib/utils';

<button className={cn(
  "rounded px-4 py-2",
  isPrimary && "bg-blue-500 text-white",
  isDisabled && "opacity-50 cursor-not-allowed"
)}>
  Click me
</button>

import { Button } from '@/components/ui/Button';
import { useMemos } from '@/hooks/useMemoQueries';
import { cn } from '@/lib/utils';

pnpm lint:fix