You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/project.launch-checklist.md
+32Lines changed: 32 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,38 @@ This checklist is designed to help you ensure a smooth and successful launch.
7
7
8
8
This is the phase where you prepare your project for its public debut.
9
9
10
+
### Initial Repository Setup
11
+
12
+
These are the very first steps to take after creating a new repository from the `base` template.
13
+
14
+
-[ ]**Choose a Repository Name:**
15
+
-**Max Characters:** 100
16
+
-**Advice:** Pick a name that is short, memorable, and descriptive of your project. Avoid using spaces; use hyphens (`-`) or underscores (`_`) instead.
17
+
18
+
-[ ]**Write a Description:**
19
+
-**Max Characters:** 350
20
+
-**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.
21
+
22
+
-[ ]**Set Up GitHub Pages Publishing:**
23
+
1. Go to your repository's **Settings** tab.
24
+
2. In the left sidebar, click on **Pages**.
25
+
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.
26
+
27
+
-[ ]**Publish Test:**
28
+
1. Make a small, visible edit to the `README.md` file (e.g., add a sentence).
29
+
2. Commit and push the change to the `main` branch.
30
+
3. Go to the **Actions** tab of your repository and wait for the `pages` workflow to complete successfully.
31
+
4. Visit your new GitHub Pages URL (e.g., `https://<your-username>.github.io/<your-repo-name>/`) to confirm that your change is live.
32
+
33
+
-[ ]**Tag an Initial Release (`v0.0.1`):**
34
+
- This step confirms that your release workflow is functioning correctly.
35
+
- Run the following commands in your local terminal:
36
+
```bash
37
+
git tag -a v0.0.1 -m "Initial setup and project scaffolding"
38
+
git push origin main --tags
39
+
```
40
+
- Go to the **Releases** page on your repository to confirm that a new `v0.0.1` release has been created automatically.
0 commit comments