Skip to content

Commit 30ea4b4

Browse files
Add AGENTS and CONTRIBUTING
1 parent af4bc82 commit 30ea4b4

File tree

2 files changed

+122
-0
lines changed

2 files changed

+122
-0
lines changed

AGENTS.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# AGENTS.md
2+
3+
Guidance for coding agents working in this repository.
4+
5+
## Purpose
6+
7+
This repository contains the static GitHub Pages landing site for the Multilingual Programming Language project.
8+
9+
## Key files
10+
11+
- `index.html`: primary page, including markup, inline CSS, and inline JavaScript
12+
- `assets/images/`: image assets used by the landing page
13+
- `README.md`: repository overview and related links
14+
- `CONTRIBUTING.md`: contributor workflow and expectations
15+
- `robots.txt`, `sitemap.xml`, `site.webmanifest`: static site metadata
16+
17+
## Working style
18+
19+
- Make focused edits that match the existing structure.
20+
- Prefer updating the single-page site in place rather than introducing new tooling.
21+
- Keep the site static unless the task explicitly requires a different approach.
22+
- Preserve current external links unless the task is to replace or refresh them.
23+
- Use ASCII by default when editing Markdown or code.
24+
25+
## Editing expectations
26+
27+
- Use `apply_patch` for direct file edits.
28+
- Do not add frameworks, package managers, or build steps without explicit user approval.
29+
- Reuse existing CSS classes and section patterns where practical.
30+
- Keep JavaScript small and dependency-free.
31+
- If you add a new section to `index.html`, make sure the copy is consistent with the rest of the page.
32+
33+
## Validation
34+
35+
After edits, do a lightweight verification pass:
36+
37+
- Confirm the intended text or links exist
38+
- Check for obvious HTML structure issues
39+
- If possible, validate any changed URLs and references locally
40+
41+
## Common tasks
42+
43+
- Add or update links to docs, playgrounds, and project repositories
44+
- Refresh landing page copy
45+
- Improve metadata or assets for GitHub Pages
46+
- Expand repository documentation
47+
48+
## Avoid
49+
50+
- Large rewrites unrelated to the user request
51+
- Destructive git operations
52+
- Introducing unnecessary complexity into a static site repository

CONTRIBUTING.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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

Comments
 (0)