| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent da790e8 commit b8b56b9
3 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,20 @@ | |||
| 1 | + # Milestones | ||
| 2 | + | ||
| 3 | + Applies whenever an issue or a pull request is created or edited, for instance with `gh issue create`, | ||
| 4 | + `gh issue edit` or `gh pr create`. | ||
| 5 | + | ||
| 6 | + ## Set a milestone on issues only, never on pull requests | ||
| 7 | + | ||
| 8 | + A milestone is named after the version it ships in, such as `0.26.0`, and tracks what that release contains. That is | ||
| 9 | + the work item, so it belongs to the issue. The pull request implementing it is only the change, and the issue it closes | ||
| 10 | + already carries the release. | ||
| 11 | + | ||
| 12 | + - When creating or editing an issue, propose a milestone along with the labels and the issue type. | ||
| 13 | + - When creating or editing a pull request, set labels only, and do not offer a milestone, even when the branch clearly | ||
| 14 | + targets a given release or adds a `@since` tag naming its version. | ||
| 15 | + - An issue fixed by a pull request gets the milestone of the first release containing that pull request, also when the | ||
| 16 | + issue is closed long after, or by its author. | ||
| 17 | + | ||
| 18 | + The release process relies on it: before a release, the maintainer looks for the issues closed as completed without a | ||
| 19 | + milestone, so a missing one shows up there, see the | ||
| 20 | + [release how-to](../../../packages/website/docs/development/release.md). | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -43,7 +43,7 @@ This document provides essential knowledge for AI coding agents to be productive | |||
| 43 | 43 | - **Mixins/Plugins**: Add new features via mixins or plugins, not by modifying core classes directly. | |
| 44 | 44 | - **Registries**: Register only required shapes/styles for tree-shaking (see `ts-example-selected-features`). | |
| 45 | 45 | - **Testing**: Use Jest. Test patterns in `.claude/rules/testing/conventions.md`. | |
| 46 | - - **Commits/PRs**: Follow `.claude/rules/git/commit-conventions.md` for commit messages and `.claude/rules/git/pull-requests.md` when updating a PR description. PRs should run full CI. | ||
| 46 | + - **Commits/PRs**: Follow `.claude/rules/git/commit-conventions.md` for commit messages, `.claude/rules/git/pull-requests.md` when updating a PR description, and `.claude/rules/git/milestones.md` before setting a milestone (issues only, never PRs). PRs should run full CI. | ||
| 47 | 47 | - **Documentation**: Update `README.md` and `CLAUDE.md` for major changes. Use concise, accurate docs. | |
| 48 | 48 | ||
| 49 | 49 | ### 4. Examples & Integration | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -59,6 +59,7 @@ Key patterns: | |||
| 59 | 59 | - See `.claude/rules/documentation/guides-structure.md` for the structure of the website guides (prerequisites, titles) | |
| 60 | 60 | - See `.claude/rules/git/commit-conventions.md` for commit message style | |
| 61 | 61 | - See `.claude/rules/git/pull-requests.md` for updating a pull request description (keep the blocks added by bots) | |
| 62 | + - See `.claude/rules/git/milestones.md` before setting a milestone (issues only, never pull requests) | ||
| 62 | 63 | ||
| 63 | 64 | ## References | |
| 64 | 65 | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments