agentme 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -13,12 +13,12 @@ metadata:
|
|
|
13
13
|
|
|
14
14
|
## Overview
|
|
15
15
|
|
|
16
|
-
Creates or extends a monorepo that follows the standard layout from [agentme-edr-005](
|
|
16
|
+
Creates or extends a monorepo that follows the standard layout from [agentme-edr-005](../../../.xdrs/agentme/edrs/devops/005-monorepo-structure.md):
|
|
17
17
|
top-level application folders, a shared library area, Mise-managed tooling, and Makefiles at every
|
|
18
18
|
level so any contributor can build, lint, and test any part of the monorepo with a single,
|
|
19
19
|
predictable command.
|
|
20
20
|
|
|
21
|
-
Related
|
|
21
|
+
Related EDRs: [agentme-edr-005](../../../.xdrs/agentme/edrs/devops/005-monorepo-structure.md), [agentme-edr-013](../../../.xdrs/agentme/edrs/governance/013-contributing-guide-requirements.md)
|
|
22
22
|
|
|
23
23
|
## Instructions
|
|
24
24
|
|
|
@@ -96,6 +96,29 @@ Must include four sections:
|
|
|
96
96
|
| `<app2>/` | <Short description of app2> |
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
+
#### Root `CONTRIBUTING.md`
|
|
100
|
+
|
|
101
|
+
Must explain the contribution workflow in a short, explicit way.
|
|
102
|
+
|
|
103
|
+
```markdown
|
|
104
|
+
# Contributing
|
|
105
|
+
|
|
106
|
+
## Bugs
|
|
107
|
+
Report bugs in GitHub issues with steps to reproduce, expected behavior, and actual behavior.
|
|
108
|
+
|
|
109
|
+
## Features
|
|
110
|
+
Discuss feature ideas in an issue before opening a pull request so scope and approach can be agreed first.
|
|
111
|
+
|
|
112
|
+
## Pull requests
|
|
113
|
+
Submit fixes and features through pull requests from feature branches targeting `main`.
|
|
114
|
+
|
|
115
|
+
## Review etiquette
|
|
116
|
+
Use [Conventional Comments](https://conventionalcomments.org/) in review feedback.
|
|
117
|
+
|
|
118
|
+
## Keep changes focused
|
|
119
|
+
Keep pull requests small and focused enough that review and discussion stay efficient.
|
|
120
|
+
```
|
|
121
|
+
|
|
99
122
|
---
|
|
100
123
|
|
|
101
124
|
### Phase 3: Create the `shared/` area
|
|
@@ -219,6 +242,7 @@ After scaffolding, run the following checks and fix any issues:
|
|
|
219
242
|
- `make lint` at the repository root passes.
|
|
220
243
|
- `make test` at the repository root passes.
|
|
221
244
|
- All folder and file names are lowercase and use hyphens.
|
|
245
|
+
- A `CONTRIBUTING.md` exists at the repository root and covers bugs, feature discussions, pull requests, Conventional Comments, and small focused changes.
|
|
222
246
|
- Every application folder has a `README.md` covering all four required sections.
|
|
223
247
|
- A `.mise.toml` exists at the repository root with all required tool versions pinned.
|
|
224
248
|
|
|
@@ -267,4 +291,4 @@ test:
|
|
|
267
291
|
- **Cross-application dependency requested:** Refuse and suggest publishing the shared code as a library in `shared/libs/` instead.
|
|
268
292
|
- **Module with no compilable output (e.g., pure scripts):** Still create the Makefile; `build` can be a no-op (`@true`) but the target must exist.
|
|
269
293
|
- **Language not listed above:** Mirror the pattern — `build` produces an artifact, `lint` runs static analysis, `test` runs tests. Adapt commands to the actual toolchain.
|
|
270
|
-
- **Existing files:** Never overwrite existing `README.md` or `Makefile` files without user confirmation. Diff and propose additions instead.
|
|
294
|
+
- **Existing files:** Never overwrite existing `README.md`, `CONTRIBUTING.md`, or `Makefile` files without user confirmation. Diff and propose additions instead.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# agentme-edr-013: Contributing guide requirements
|
|
2
|
+
|
|
3
|
+
## Context and Problem Statement
|
|
4
|
+
|
|
5
|
+
Projects often document contributor expectations inconsistently or only inside README files, PR templates, or tribal knowledge. That causes avoidable review churn, premature feature implementation, and unfocused pull requests.
|
|
6
|
+
|
|
7
|
+
What contributor workflow guidance must every project publish so contributors know how to report bugs, discuss features, and submit changes?
|
|
8
|
+
|
|
9
|
+
## Decision Outcome
|
|
10
|
+
|
|
11
|
+
**Every project must publish a root CONTRIBUTING.md with a small, explicit contribution workflow.**
|
|
12
|
+
|
|
13
|
+
Projects must keep a `CONTRIBUTING.md` file at the repository root. The file must explain where bugs, feature discussions, and code changes belong so contributors follow a predictable workflow before opening pull requests.
|
|
14
|
+
|
|
15
|
+
### Implementation Details
|
|
16
|
+
|
|
17
|
+
- Every project **MUST** have a root `CONTRIBUTING.md`.
|
|
18
|
+
- The guide **MUST** direct bug reports to issues.
|
|
19
|
+
- The guide **MUST** direct feature ideas and feature discussions to issues before implementation starts.
|
|
20
|
+
- The guide **MUST** state that fixes and features are contributed through pull requests.
|
|
21
|
+
- The guide **MUST** state that pull requests come from feature branches targeting `main`.
|
|
22
|
+
- The guide **MUST** ask reviewers and contributors to use [Conventional Comments](https://conventionalcomments.org/) for review feedback.
|
|
23
|
+
- The guide **MUST** ask contributors to keep pull requests small enough to keep review and discussion focused.
|
|
24
|
+
- Project scaffolding skills **SHOULD** create the file by default when they initialize a repository.
|
|
25
|
+
- The content **SHOULD** stay concise and practical; do not turn `CONTRIBUTING.md` into a duplicate of `README.md`.
|
|
26
|
+
|
|
27
|
+
## Considered Options
|
|
28
|
+
|
|
29
|
+
* (REJECTED) **Keep contribution rules implicit** - Rely on README text, issue templates, or maintainers explaining the workflow ad hoc.
|
|
30
|
+
* Reason: Inconsistent contributor behavior and avoidable review overhead.
|
|
31
|
+
* (CHOSEN) **Require a dedicated CONTRIBUTING.md** - Publish a short, explicit contribution workflow in a predictable location.
|
|
32
|
+
* Reason: Easy to discover, simple to scaffold, and clear enough for both humans and agents.
|
|
33
|
+
|
|
34
|
+
## References
|
|
35
|
+
|
|
36
|
+
- [agentme-edr-005 - Monorepo structure](../devops/005-monorepo-structure.md)
|
|
37
|
+
- [002-monorepo-setup skill](../devops/skills/002-monorepo-setup/SKILL.md)
|
|
@@ -4,12 +4,6 @@ Engineering decisions specific to the agentme project: a curated library of XDRs
|
|
|
4
4
|
|
|
5
5
|
Propose changes via pull request. All changes must be verified for clarity and non-conflict before merging.
|
|
6
6
|
|
|
7
|
-
## Related scope indexes
|
|
8
|
-
|
|
9
|
-
- [_core EDRs Index](../../_core/edrs/index.md) - Cross-business general standards (overridden by this scope where conflicts are documented)
|
|
10
|
-
|
|
11
|
-
XDRs in scopes listed last override the ones listed first.
|
|
12
|
-
|
|
13
7
|
## Principles
|
|
14
8
|
|
|
15
9
|
Foundational standards, principles, and guidelines.
|
|
@@ -32,6 +26,7 @@ Language and framework-specific tooling and project structure.
|
|
|
32
26
|
|
|
33
27
|
- [agentme-edr-003](application/003-javascript-project-tooling.md) - **JavaScript project tooling and structure** *(includes skill: [001-create-javascript-project](application/skills/001-create-javascript-project/SKILL.md))*
|
|
34
28
|
- [agentme-edr-010](application/010-golang-project-tooling.md) - **Go project tooling and structure** *(includes skill: [003-create-golang-project](application/skills/003-create-golang-project/SKILL.md))*
|
|
29
|
+
- [004-select-relevant-xdrs](application/skills/004-select-relevant-xdrs/SKILL.md) - **Select relevant XDRs**
|
|
35
30
|
|
|
36
31
|
## Devops
|
|
37
32
|
|
|
@@ -41,6 +36,12 @@ Repository structure, build conventions, and CI/CD pipelines.
|
|
|
41
36
|
- [agentme-edr-006](devops/006-github-pipelines.md) - **GitHub CI/CD pipelines**
|
|
42
37
|
- [agentme-edr-008](devops/008-common-targets.md) - **Common development script names**
|
|
43
38
|
|
|
39
|
+
## Governance
|
|
40
|
+
|
|
41
|
+
Contribution and collaboration standards shared across projects.
|
|
42
|
+
|
|
43
|
+
- [agentme-edr-013](governance/013-contributing-guide-requirements.md) - **Contributing guide requirements**
|
|
44
|
+
|
|
44
45
|
## Observability
|
|
45
46
|
|
|
46
47
|
Health, metrics, logging, and monitoring standards.
|
package/.xdrs/index.md
CHANGED
package/package.json
CHANGED