First Release v1.0.0
This commit is contained in:
@@ -0,0 +1,29 @@
|
||||
# Code of Conduct
|
||||
|
||||
## Our Standards
|
||||
|
||||
Astro Rocket is an open-source project and everyone who participates — whether through issues, pull requests, discussions, or any other channel — is expected to treat others with respect and professionalism.
|
||||
|
||||
**Expected behaviour:**
|
||||
- Be welcoming and considerate in your language and actions
|
||||
- Offer and accept constructive feedback graciously
|
||||
- Focus on what is best for the project and the community
|
||||
- Show patience with contributors of all experience levels
|
||||
|
||||
**Unacceptable behaviour:**
|
||||
- Personal attacks, insults, or derogatory comments
|
||||
- Public or private intimidation of any kind
|
||||
- Sharing others' private information without permission
|
||||
- Any conduct that would be considered unprofessional in a work setting
|
||||
|
||||
## Scope
|
||||
|
||||
This code of conduct applies to all project spaces — GitHub issues, pull requests, discussions, and any other official communication channel.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of unacceptable behaviour may be reported to [hello@hansmartens.dev](mailto:hello@hansmartens.dev). All reports will be reviewed and handled with discretion. Maintainers reserve the right to remove, edit, or reject contributions that do not align with this code of conduct, and to temporarily or permanently exclude anyone whose behaviour is deemed harmful to the project.
|
||||
|
||||
## Attribution
|
||||
|
||||
This code of conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.
|
||||
@@ -0,0 +1,93 @@
|
||||
# Contributing to Astro Rocket
|
||||
|
||||
Thank you for your interest in contributing. Astro Rocket is a free, open-source Astro 6 starter theme — every improvement, however small, makes it better for everyone who builds with it.
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
- **Report a bug** — something broken or behaving unexpectedly
|
||||
- **Suggest a feature** — an idea for a new component, page, or configuration option
|
||||
- **Fix a bug** — pick up an open issue and submit a pull request
|
||||
- **Improve documentation** — fix a typo, clarify an instruction, or improve an example
|
||||
- **Improve accessibility** — help make the theme usable for everyone
|
||||
|
||||
## Before you start
|
||||
|
||||
- Check the [open issues](https://github.com/hansmartens68/Astro-Rocket/issues) to avoid duplicating work
|
||||
- For significant changes, open an issue first to discuss the approach before writing code
|
||||
- All contributions are released under the [MIT License](../LICENSE)
|
||||
|
||||
## Development setup
|
||||
|
||||
**Prerequisites:** Node.js ≥ 22.12.0 and pnpm
|
||||
|
||||
```bash
|
||||
# Fork and clone the repo
|
||||
git clone https://github.com/YOUR_USERNAME/Astro-Rocket.git
|
||||
cd Astro-Rocket
|
||||
|
||||
# Copy the environment file
|
||||
cp .env.example .env
|
||||
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
|
||||
# Start the dev server
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## Branch naming
|
||||
|
||||
| Type | Pattern | Example |
|
||||
|---|---|---|
|
||||
| New feature | `feature/short-description` | `feature/add-breadcrumbs` |
|
||||
| Bug fix | `fix/short-description` | `fix/mobile-nav-overflow` |
|
||||
| Content or config | `update/short-description` | `update/readme-installation` |
|
||||
|
||||
Always branch from `main`.
|
||||
|
||||
## Before submitting a pull request
|
||||
|
||||
All three checks must pass with zero errors:
|
||||
|
||||
```bash
|
||||
pnpm lint # ESLint
|
||||
pnpm check # Astro type checking
|
||||
pnpm build # Production build
|
||||
```
|
||||
|
||||
If any check fails, fix the errors before opening the PR. The CI workflow runs the same checks automatically.
|
||||
|
||||
## Commit messages
|
||||
|
||||
Write clear, specific commit messages that describe what changed and why.
|
||||
|
||||
```
|
||||
# Good
|
||||
Add keyboard navigation to theme selector dropdown
|
||||
Fix contact form validation on mobile Safari
|
||||
Update installation docs to reflect pnpm lockfile requirement
|
||||
|
||||
# Too vague
|
||||
fix
|
||||
update
|
||||
changes
|
||||
```
|
||||
|
||||
## Pull request guidelines
|
||||
|
||||
- Keep pull requests focused — one concern per PR
|
||||
- Reference the issue number if applicable: `Fixes #42`
|
||||
- Fill in the PR description template — describe what changed, why, and how to test it
|
||||
- Be responsive to review feedback
|
||||
|
||||
## Code style
|
||||
|
||||
- TypeScript is required for all `.astro` and `.ts` files
|
||||
- Tailwind utility classes follow the existing ordering conventions
|
||||
- No inline styles unless unavoidable
|
||||
- Components go in `src/components/`, pages in `src/pages/`, layouts in `src/layouts/`
|
||||
- Follow the existing file and folder naming conventions
|
||||
|
||||
## Questions
|
||||
|
||||
Open a [GitHub Discussion](https://github.com/hansmartens68/Astro-Rocket/discussions) or reach out on X at [@hansmartens_dev](https://x.com/hansmartens_dev).
|
||||
@@ -0,0 +1 @@
|
||||
github: [hansmartens68]
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Something is broken or not working as expected
|
||||
title: "[Bug] "
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Describe the bug
|
||||
|
||||
A clear description of what the bug is.
|
||||
|
||||
## Steps to reproduce
|
||||
|
||||
1. Go to '...'
|
||||
2. Click on '...'
|
||||
3. See error
|
||||
|
||||
## Expected behaviour
|
||||
|
||||
What you expected to happen.
|
||||
|
||||
## Actual behaviour
|
||||
|
||||
What actually happened.
|
||||
|
||||
## Environment
|
||||
|
||||
- OS: [e.g. macOS 14, Windows 11]
|
||||
- Node version: [e.g. 22.12.0]
|
||||
- pnpm version: [e.g. 9.x]
|
||||
- Browser (if relevant): [e.g. Chrome 120, Safari 17]
|
||||
|
||||
## Screenshots or error output
|
||||
|
||||
If applicable, add screenshots or paste any error messages here.
|
||||
|
||||
## Additional context
|
||||
|
||||
Any other context that might be relevant.
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest a new component, page, or improvement for Astro Rocket
|
||||
title: "[Feature] "
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## What problem does this solve?
|
||||
|
||||
A clear description of the problem or gap this feature would address.
|
||||
|
||||
## Describe the solution you'd like
|
||||
|
||||
What would you like to see added or changed? Be as specific as you can.
|
||||
|
||||
## Alternatives you've considered
|
||||
|
||||
Any other approaches or workarounds you've thought about.
|
||||
|
||||
## Additional context
|
||||
|
||||
Screenshots, links, or examples that illustrate your idea.
|
||||
@@ -0,0 +1,25 @@
|
||||
## What does this PR do?
|
||||
|
||||
A clear description of the change and why it was made.
|
||||
|
||||
Fixes # (issue number, if applicable)
|
||||
|
||||
## Type of change
|
||||
|
||||
- [ ] Bug fix
|
||||
- [ ] New feature or component
|
||||
- [ ] Documentation update
|
||||
- [ ] Refactor or code quality improvement
|
||||
- [ ] Other: ___
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] `pnpm lint` passes with 0 errors
|
||||
- [ ] `pnpm check` passes with 0 errors
|
||||
- [ ] `pnpm build` completes successfully
|
||||
- [ ] I have tested this change in the browser
|
||||
- [ ] No unnecessary files are included in this PR
|
||||
|
||||
## Screenshots (if relevant)
|
||||
|
||||
Add before/after screenshots for visual changes.
|
||||
@@ -0,0 +1,45 @@
|
||||
name: Deploy to Azure Static Web Apps
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened, closed]
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
build_and_deploy:
|
||||
if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed')
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup pnpm
|
||||
run: corepack enable pnpm
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
cache: 'pnpm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Build
|
||||
run: pnpm run build
|
||||
env:
|
||||
SITE_URL: ${{ secrets.SITE_URL }}
|
||||
|
||||
- name: Deploy to Azure Static Web Apps
|
||||
run: npx --yes @azure/static-web-apps-cli@latest deploy dist --deployment-token "${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN }}" --env production
|
||||
|
||||
close_pull_request:
|
||||
if: github.event_name == 'pull_request' && github.event.action == 'closed'
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Close preview environment
|
||||
run: npx --yes @azure/static-web-apps-cli@latest deploy --deployment-token "${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN }}" --env close
|
||||
Reference in New Issue
Block a user