Add contributor guide#285
Conversation
andydotxyz
left a comment
andydotxyz
left a comment
There was a problem hiding this comment.
Please re-word this to be a contributor focused document instead of an AI summary.
| git checkout -b your-change | ||
| ``` | ||
|
|
||
| Some local checks and tests need desktop or graphics-related system libraries. The GitHub Actions workflows install packages such as `clang`, `lld`, Mesa/OpenGL development libraries, X11/Wayland development libraries, `libpam-dev`, and `xvfb` on Linux. |
There was a problem hiding this comment.
This seems to be a report of what actions have been seen to do rather than what contributors should set up. It would be better to be explicit or link to https://docs.fyne.io/started/quick/
| Run the Go test suite before opening a pull request: | ||
|
|
||
| ```bash | ||
| go test -tags ci -covermode=atomic -coverprofile=coverage.out ./... |
There was a problem hiding this comment.
covermode adds slowness and is not required to test.
| go test -tags ci -covermode=atomic -coverprofile=coverage.out ./... | ||
| ``` | ||
|
|
||
| On Linux, the CI workflow runs the main test suite under `xvfb-run` and also runs Wayland-specific tests: |
There was a problem hiding this comment.
Another actions report - this is not needed for developers as they have X running already.
| - which tests and static checks you ran | ||
| - whether the change affects public APIs, desktop behavior, window manager behavior, or platform-specific code | ||
|
|
||
| The pull request template asks contributors to include tests, run lint and formatting checks, and confirm that tests pass. If any item does not apply, explain why in the pull request. |
There was a problem hiding this comment.
This also seems like an AI-ism. Describe that the user should do rather than what they might find.
i.e. When opening a pull request remember to complete the pull request template on GitHub
2 participants
Adds a
CONTRIBUTING.mdguide with branch guidance, local test commands, static analysis commands, and pull request expectations.Why:
Validation: