|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thanks for improving the Multilingual Programming Language landing site. |
| 4 | + |
| 5 | +## Scope |
| 6 | + |
| 7 | +This repository hosts the public GitHub Pages website for the project. Most changes here fall into one of these categories: |
| 8 | + |
| 9 | +- Updating landing page copy in `index.html` |
| 10 | +- Refreshing links to related repositories or live demos |
| 11 | +- Improving visuals, layout, metadata, or accessibility |
| 12 | +- Updating static assets such as logos, icons, and social preview images |
| 13 | +- Improving repository documentation |
| 14 | + |
| 15 | +## Repository layout |
| 16 | + |
| 17 | +- `index.html`: main landing page, inline styles, and inline JavaScript |
| 18 | +- `assets/images/`: logos, favicon source, and social preview assets |
| 19 | +- `robots.txt`, `sitemap.xml`, `site.webmanifest`: site metadata files |
| 20 | + |
| 21 | +## Development workflow |
| 22 | + |
| 23 | +1. Create a branch for your change. |
| 24 | +2. Make focused edits. |
| 25 | +3. Preview the site locally in a browser. |
| 26 | +4. Verify links, responsive layout, and basic accessibility. |
| 27 | +5. Open a pull request with a concise summary. |
| 28 | + |
| 29 | +## Local preview |
| 30 | + |
| 31 | +You can use a lightweight static server: |
| 32 | + |
| 33 | +```bash |
| 34 | +python -m http.server 8000 |
| 35 | +``` |
| 36 | + |
| 37 | +Then visit `http://localhost:8000/`. |
| 38 | + |
| 39 | +## Content guidelines |
| 40 | + |
| 41 | +- Keep language clear and concise. |
| 42 | +- Prefer official project URLs under `multilingualprogramming.github.io` and `github.com/multilingualprogramming` when available. |
| 43 | +- Preserve the current visual style unless the change is intentionally a design refresh. |
| 44 | +- Keep external links opening safely with `target="_blank"` and `rel="noopener"` where appropriate. |
| 45 | + |
| 46 | +## HTML, CSS, and JS guidance |
| 47 | + |
| 48 | +- Favor small, localized edits over broad rewrites. |
| 49 | +- Preserve semantic HTML and existing section structure where possible. |
| 50 | +- Reuse existing utility classes and visual patterns before adding new ones. |
| 51 | +- Keep JavaScript minimal and framework-free. |
| 52 | +- Avoid introducing build tooling unless explicitly discussed first. |
| 53 | + |
| 54 | +## Before submitting |
| 55 | + |
| 56 | +Please check: |
| 57 | + |
| 58 | +- The page loads without console errors in a browser |
| 59 | +- New links are correct |
| 60 | +- Mobile and desktop layouts still work |
| 61 | +- Copy changes are free of obvious typos |
| 62 | +- Any added assets are optimized and referenced correctly |
| 63 | + |
| 64 | +## Pull request notes |
| 65 | + |
| 66 | +A good pull request includes: |
| 67 | + |
| 68 | +- A short description of what changed |
| 69 | +- Screenshots for visible UI updates |
| 70 | +- Notes about any follow-up work or open questions |
0 commit comments