bitflicker64 opened a new pull request, #3197:
URL: https://github.com/apache/hugegraph/pull/3197
## Purpose of the PR
`AGENTS.md` describes the module layout, the build and the test profiles,
but it says
nothing about how code is expected to be written in this repo. Without that,
agents fall
back on generic best practice: they add an interface where the existing
class would do,
widen a fix into a refactor, or explain a tricky case in a long block
comment that then
drifts out of date.
This adds the missing part, kept short on purpose so the file stays usable
as a prompt.
There is no issue to close; this follows from review feedback on recent PRs
about comment
length and PR scope.
## Main Changes
- New `Design philosophy` section, four points:
- extend existing code before introducing a new abstraction
- keep the change minimal, adjacent cleanups go in their own PR
- one concern per PR
- comments stay short, link the issue when something needs real context
- Two additions to `Cross-module notes`, in the same "change X, also update
Y" shape as
the existing entries:
- feature, config and `Dockerfile` changes ship a paired PR in
`apache/hugegraph-doc`
- README wraps at 120, stays thin, detail goes to hugegraph-doc,
non-urgent parts fold
into `<details>`
16 lines added, nothing removed or reworded.
## Verifying these changes
- [x] Trivial rework / code cleanup without any test coverage. (No Need)
- [ ] Already covered by existing tests, such as *(please modify tests
here)*.
- [ ] Need tests and can be verified as follows:
- xxx
## Does this PR potentially affect the following parts?
- [ ] Dependencies ([add/update
license](https://hugegraph.apache.org/docs/contribution-guidelines/contribute/#321-check-licenses)
info &
[regenerate_known_dependencies.sh](../install-dist/scripts/dependency/regenerate_known_dependencies.sh))
- [ ] Modify configurations
- [ ] The public API
- [ ] Other affects (typed here)
- [x] Nope
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
