Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.77 KB

Contributing.md

File metadata and controls

81 lines (55 loc) · 2.77 KB

Contributing Guide

Thanks for your interest in this project!

This repository contains the source for my personal website (Astro + Tailwind) and its GitHub Pages setup. Issues and PRs are welcome for code and site improvements. Long-form content submissions (articles, etc.) are not accepted via direct commits; please contact me first.

What can I contribute?

  • Report issues: open a GitHub Issue for bugs or suggestions.
  • Contribute code: open a Pull Request.
  • Copy/content tweaks: fix UI copy, typos, links, layout issues.
  • Documentation: improve README, development notes, comments.

Note: Long-form content is curated and published by me after private coordination.

Filing an Issue

Format is flexible—prioritize clarity, specificity, and reproducibility:

  • Expected vs. actual behavior
  • Reproduction steps (minimal if possible)
  • Environment (OS, browser/Node version, etc.)
  • Screenshots/logs (if any)

Suggested outline:

  • Title: concise and precise (e.g., "TOC not visible in dark mode (Astro 5.13)")
  • Description: 1–2 paragraphs of background and impact
  • Repro: bullet steps
  • Expected: what you intended to happen

Submitting a PR

  1. Open an Issue first to align on motivation and approach (small fixes can go straight to PR).
  2. Fork the repo and create a topic branch (e.g., feat/xyz, fix/abc).
  3. Local dev:
    • pnpm install
    • pnpm dev
    • pnpm build before submitting to ensure it compiles cleanly.
  4. Commit messages: be clear and scoped (e.g., fix: show TOC in dark mode).
  5. PR description:
    • Motivation and context
    • Key changes (bullet list)
    • Screenshots/screencasts for UI changes
    • Compatibility risks or potential side effects

Code style & conventions

  • Follow the existing structure and style; keep diffs minimal.
  • TypeScript/JS: ESM; components/pages follow Astro conventions.
  • Styling: prefer Tailwind utility classes; shared styles in src/styles/.
  • Assets: images/SVGs go to public/ or src/assets/ depending on usage.
  • Language: English-first for Issues/PRs.

Tests & self-checks

  • Run pnpm build to ensure a successful build.
  • Do a quick smoke test (open key pages, theme toggle, TOC, etc.).

Content submissions (contact first)

If you want to publish or rehost content on the site, contact me first and share:

  • Title and abstract
  • Copyright and permissions (original/translation/repost; scope)
  • Sources for images and references
  • Desired timeline

I’ll curate, review, and publish after we agree on details.

License & copyright

GPL-3.0-or-later. By contributing, you agree your contributions are licensed under the project license.

Contact

See the About page on the site or the contact notes in the repository README.

Authored by FlowerCA77 with assistance from GitHub Copilot (AI-generated content).