Skip to content

Docs: Expand launch checklist with initial setup steps #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
attogram merged 1 commit into from
Sep 5, 2025
Merged

Docs: Expand launch checklist with initial setup steps #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/project.launch-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,38 @@ Launching a new open-source project can be a daunting task. This checklist is de

This is the phase where you prepare your project for its public debut.

### Initial Repository Setup

These are the very first steps to take after creating a new repository from the `base` template.

- [ ] **Choose a Repository Name:**
- **Max Characters:** 100
- **Advice:** Pick a name that is short, memorable, and descriptive of your project. Avoid using spaces; use hyphens (`-`) or underscores (`_`) instead.

- [ ] **Write a Description:**
- **Max Characters:** 350
- **Advice:** This is your project's "elevator pitch." Briefly explain what your project does and who it's for. This description is shown in search results and on the repository page.

- [ ] **Set Up GitHub Pages Publishing:**
1. Go to your repository's **Settings** tab.
2. In the left sidebar, click on **Pages**.
3. Under "Build and deployment," for the **Source**, select **GitHub Actions**. This repository is pre-configured with a workflow to build and deploy your site.

- [ ] **Publish Test:**
1. Make a small, visible edit to the `README.md` file (e.g., add a sentence).
2. Commit and push the change to the `main` branch.
3. Go to the **Actions** tab of your repository and wait for the `pages` workflow to complete successfully.
4. Visit your new GitHub Pages URL (e.g., `https://<your-username>.github.io/<your-repo-name>/`) to confirm that your change is live.

- [ ] **Tag an Initial Release (`v0.0.1`):**
- This step confirms that your release workflow is functioning correctly.
- Run the following commands in your local terminal:
```bash
git tag -a v0.0.1 -m "Initial setup and project scaffolding"
git push origin main --tags
```
- Go to the **Releases** page on your repository to confirm that a new `v0.0.1` release has been created automatically.

### Code and Repository

- [ ] Finalize initial feature set for `v1.0.0`.
Expand Down