Skip to content

Commit 16e4c74

Browse files
authored
Merge PR #13: Add repository readiness and contributor governance
Add repository contribution and Codex review guidance
2 parents d1ae610 + b8a2e52 commit 16e4c74

10 files changed

Lines changed: 289 additions & 2 deletions

File tree

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Bug report
2+
description: Report incorrect behavior or a regression
3+
title: "Bug: "
4+
labels: []
5+
body:
6+
- type: textarea
7+
id: behavior
8+
attributes:
9+
label: What happened?
10+
description: Describe the observed and expected behavior.
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: reproduction
15+
attributes:
16+
label: Reproduction
17+
description: Include controls used, character/location, and repeatable steps.
18+
validations:
19+
required: true
20+
- type: input
21+
id: environment
22+
attributes:
23+
label: Browser and device
24+
placeholder: Safari 20 on iPhone, Chrome on macOS, etc.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: evidence
29+
attributes:
30+
label: Evidence
31+
description: Add screenshots, recordings, console errors, or other useful detail.
32+
- type: checkboxes
33+
id: checks
34+
attributes:
35+
label: Checks
36+
options:
37+
- label: I checked for an existing issue.
38+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security report
4+
url: https://github.com/mcvalosborne/littleandroid/security
5+
about: Report sensitive vulnerabilities privately rather than opening an issue.

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Feature proposal
2+
description: Propose a focused gameplay, UX, or contributor improvement
3+
title: "Feature: "
4+
labels: []
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: Problem or opportunity
10+
description: Explain the player or contributor need before describing a solution.
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: proposal
15+
attributes:
16+
label: Proposed experience
17+
description: Describe the smallest useful implementation.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: success
22+
attributes:
23+
label: Success criteria
24+
description: How would we verify that this improves the project?
25+
validations:
26+
required: true
27+
- type: dropdown
28+
id: area
29+
attributes:
30+
label: Primary area
31+
options:
32+
- Gameplay
33+
- UI and UX
34+
- Accessibility
35+
- Performance
36+
- Community
37+
- Tooling
38+
validations:
39+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Summary
2+
3+
<!-- What changes for a player, contributor, or maintainer? -->
4+
5+
Closes #
6+
7+
## Verification
8+
9+
- [ ] Relevant automated checks pass.
10+
- [ ] Movement, scanning, and NPC interaction still work when affected.
11+
- [ ] Desktop viewport checked for visual changes.
12+
- [ ] Phone viewport checked for visual changes.
13+
- [ ] Accessibility impact considered.
14+
15+
Commands and manual checks performed:
16+
17+
```text
18+
19+
```
20+
21+
## Evidence
22+
23+
<!-- Add screenshots, recordings, logs, or a concise explanation when visual evidence is not applicable. -->
24+
25+
## Risks
26+
27+
<!-- Note behavior changes, follow-up work, or known limitations. -->

AGENTS.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Little Android Repository Guidance
2+
3+
## Product intent
4+
5+
Little Android is a small, handcrafted browser world. Preserve its quiet pixel-art identity, immediate interaction, and static hosting model. Prefer focused improvements over framework or dependency growth.
6+
7+
## Engineering conventions
8+
9+
- Keep runtime code understandable without a large toolchain.
10+
- Separate world data, state transitions, input, and rendering when adding modules.
11+
- Keep game-state updates deterministic where practical; inject time and randomness into testable logic.
12+
- Use elapsed time for behavior and animation durations. Do not assume 60 Hz.
13+
- Treat touch, keyboard, and pointer input as equal product surfaces.
14+
- Preserve current behavior unless the linked issue explicitly changes it.
15+
- Add tests for movement, pathfinding, collisions, persistence, and progression when those areas change.
16+
- For visual work, verify at desktop and phone viewports and include screenshots or equivalent evidence.
17+
18+
## Verification
19+
20+
Run every command documented in the README and package scripts that applies to the change. A pull request must state what was run and what could not be run.
21+
22+
## Review guidelines
23+
24+
Prioritize correctness, accessibility, regressions, and missing tests. Treat the following as P1 findings:
25+
26+
- Two entities can occupy or reserve the same tile.
27+
- A change can lose, corrupt, or unintentionally reset player progress.
28+
- Core movement, scan, or interaction is unavailable to keyboard or touch users.
29+
- HUD content overlaps or becomes unusable at supported phone sizes.
30+
- Timed behavior changes with display refresh rate.
31+
- The game loop continues expensive work while the page is hidden.
32+
- Untrusted contributed data can inject HTML or JavaScript.
33+
34+
Also verify that new dependencies are justified, static deployment remains functional, and user-facing changes include appropriate feedback rather than silent state changes.

CODE_OF_CONDUCT.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Code of Conduct
2+
3+
## Our standard
4+
5+
Contributors must make participation respectful and useful. Be specific when discussing code or design, assume good intent, and critique the work rather than the person.
6+
7+
Unacceptable behavior includes harassment, discriminatory language, threats, deliberate disruption, publication of private information, and unwanted sexual attention.
8+
9+
## Scope
10+
11+
This standard applies in repository issues, pull requests, discussions, and other project spaces. It also applies when someone is representing the project publicly.
12+
13+
## Reporting
14+
15+
Report conduct concerns privately to the repository owner through their GitHub profile. Reports will be reviewed promptly and handled with discretion. Maintainers may edit or remove contributions, restrict participation, or permanently ban participants when necessary to protect the project community.
16+
17+
## Attribution
18+
19+
This compact policy is informed by the Contributor Covenant and is intended for the current size of the project. It can be replaced by the full Contributor Covenant as the community grows.

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing
2+
3+
## Before starting
4+
5+
1. Check the [roadmap](https://github.com/mcvalosborne/littleandroid/issues/12) and existing issues.
6+
2. Comment on an issue before taking broad or overlapping work.
7+
3. Keep one behavioral objective per pull request.
8+
9+
## Local workflow
10+
11+
The current production page has no build step. Serve the repository and open it in a browser:
12+
13+
```sh
14+
python3 -m http.server 8000
15+
```
16+
17+
Before submitting, exercise movement, click-to-move, scanning, and at least one NPC interaction. Use the repository's automated checks as they are introduced under issue #4.
18+
19+
## Pull requests
20+
21+
- Link the issue with `Closes #<number>` when the work fully satisfies it.
22+
- Explain the behavioral change and important implementation decisions.
23+
- List automated and manual verification.
24+
- Include desktop and phone evidence for visual changes.
25+
- Keep unrelated formatting and refactors out of the patch.
26+
- Resolve or explicitly discuss P0/P1 review findings before merge.
27+
28+
## Design principles
29+
30+
- Preserve the restrained pixel-art palette and compact HUD.
31+
- Keep controls discoverable without tutorial modals.
32+
- Do not require audio, fine motor precision, or color perception to progress.
33+
- Prefer data-driven additions for characters, dialogue, and discoveries.
34+
35+
## Community content
36+
37+
Only submit work you have the right to license under the project's MIT License. Credit collaborators and sources in the pull request. Do not include personal data, tracking identifiers, or unreviewed executable content.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 mcvalosborne
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,53 @@
1-
# littleandroid
2-
littleandroid.com - Interactive pixel art landing page
1+
# Little Android
2+
3+
An explorable pixel-art micro-world rendered entirely in the browser. Walk through the river factory zone, scan its residents, and discover the small behaviors that make the settlement feel alive.
4+
5+
**[Play Little Android](https://littleandroid.com)**
6+
7+
## Controls
8+
9+
| Action | Input |
10+
| --- | --- |
11+
| Move | `W` `A` `S` `D` or click/tap a destination |
12+
| Scan or interact | `Space` |
13+
| Interact with an adjacent character | Click/tap the character |
14+
15+
The current mobile experience supports tap-to-move. A dedicated touch action control is tracked in [issue #2](https://github.com/mcvalosborne/littleandroid/issues/2).
16+
17+
## What is here
18+
19+
- A hand-built 24 by 20 tile world with animated water, vegetation, and factory scenery
20+
- Eight residents with distinct movement and interaction state machines
21+
- Grid-based movement and click-to-move pathfinding
22+
- A radial scan that reveals character identities
23+
- No runtime framework, backend, or asset bundle
24+
25+
## Run locally
26+
27+
The production version is a static page. Open `index.html` directly in a browser, or serve the directory with any static server:
28+
29+
```sh
30+
python3 -m http.server 8000
31+
```
32+
33+
Then open `http://localhost:8000`.
34+
35+
## Project direction
36+
37+
The project is moving from an ambient interactive vignette toward a polished five-minute micro-game. The work is organized in the [master roadmap](https://github.com/mcvalosborne/littleandroid/issues/12):
38+
39+
1. Establish contributor tooling, tests, and review gates.
40+
2. Correct movement and interaction edge cases.
41+
3. Complete mobile, accessibility, and performance work.
42+
4. Add a signal-recovery quest, narrative progression, and sensory polish.
43+
5. Add measured return, sharing, and community contribution loops.
44+
45+
## Contributing
46+
47+
Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request. Keep changes focused, preserve static hosting, and include verification evidence for interaction or visual changes.
48+
49+
Codex review follows the repository rules in [AGENTS.md](AGENTS.md).
50+
51+
## License
52+
53+
Source code and original project assets are available under the [MIT License](LICENSE).

SECURITY.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Security Policy
2+
3+
## Reporting a vulnerability
4+
5+
Do not open a public issue for a vulnerability that could put visitors or contributors at risk. Contact the repository owner privately through their GitHub profile with:
6+
7+
- the affected file or behavior;
8+
- reproduction steps;
9+
- likely impact;
10+
- any suggested mitigation.
11+
12+
The maintainer will acknowledge the report, assess severity, and coordinate disclosure. This static project currently has no supported release branches; fixes are applied to `main` and deployed through the configured site hosting.
13+
14+
## Scope
15+
16+
Relevant reports include script injection, unsafe community-content parsing, compromised dependencies, leaked credentials, and privacy-impacting analytics behavior.

0 commit comments

Comments
 (0)