Skip to content

Commit 958aeba

Browse files
authored
Merge pull request #1 from kyoto-tech/ash/contributors
updated readme with contributing and deploy notes
2 parents 4ecbfdd + 1d687be commit 958aeba

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

.github/workflows/deploy.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
push:
55
branches:
66
- main
7+
pull_request:
78
workflow_dispatch:
89

910
permissions:
@@ -40,6 +41,7 @@ jobs:
4041
path: dist
4142

4243
deploy:
44+
if: github.event_name == 'push'
4345
needs: build
4446
runs-on: ubuntu-latest
4547
environment:

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,14 @@ public/ # Files served as-is (favicon, images)
5858

5959
## Contributing
6060

61-
1. Fork or clone the repo and create a feature branch.
62-
2. Make your changes with clear, accessible copy. Favor data-driven component props when adding new sections.
63-
3. Run `npm run check` before opening a pull request to ensure lint, type, and Astro diagnostics all pass.
64-
4. Describe what you changed and, if applicable, attach screenshots of UI updates for quicker reviews.
61+
1. Fork or clone the repo, then branch from `main`.
62+
2. Make your changes and commit on your branch.
63+
3. Before submitting a pull request:
64+
1. Ensure your local branch is up to date with `main`.
65+
2. Run `npm run check` to ensure lint, type, and Astro diagnostics all pass.
66+
4. Push your branch to the remote repository.
67+
5. Open a pull request, describing what you changed.
68+
6. Request a review.
6569

6670
## Ideas for Contributions
6771

@@ -71,6 +75,12 @@ public/ # Files served as-is (favicon, images)
7175
- Add tests or visual regression tooling for future redesigns.
7276
- Internationalization or localization improvements for Japanese/English visitors.
7377

78+
## Deployment
79+
80+
- The site is deployed automatically to [GitHub Pages](https://kyoto-tech.github.io) via the workflow in `.github/workflows/deploy.yml`.
81+
- Any push to `main` triggers `npm ci`, `npm run build`, and then publishes the `dist/` directory using `actions/deploy-pages`.
82+
- To test a production build locally, use `npm run build && npm run preview`.
83+
7484
## Interacting with the community
7585

7686
- **Want to report a bug or suggest a feature?**

0 commit comments

Comments
 (0)