|
| 1 | +<!-- |
| 2 | + Thanks for contributing to GitProxy! |
| 3 | + Please read CONTRIBUTING.md before submitting your PR: |
| 4 | + https://github.com/finos/git-proxy/blob/main/CONTRIBUTING.md |
| 5 | +--> |
| 6 | + |
| 7 | +## Description |
| 8 | + |
| 9 | +<!-- Provide a clear and concise description of the changes in this PR. --> |
| 10 | + |
| 11 | +## Related Issue |
| 12 | + |
| 13 | +<!-- Link the issue this PR addresses. Use a closing keyword to auto-close it on merge. --> |
| 14 | +<!-- Example: Resolves #123 --> |
| 15 | + |
| 16 | +Resolves # |
| 17 | + |
| 18 | +## Checklist |
| 19 | + |
| 20 | +<!-- Check items that apply by replacing [ ] with [x]. --> |
| 21 | + |
| 22 | +### General |
| 23 | + |
| 24 | +- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines |
| 25 | +- [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) format |
| 26 | +- [ ] I have a [FINOS CLA](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Contribution+Compliance+Requirements) on file |
| 27 | + |
| 28 | +### Documentation |
| 29 | + |
| 30 | +<!-- |
| 31 | + Documentation lives in two locations: |
| 32 | + - website/docs/ — User-facing docs published to https://git-proxy.finos.org (quickstart, configuration, deployment) |
| 33 | + - docs/ — Technical docs such as architecture, processors, and upgrade guides |
| 34 | +--> |
| 35 | + |
| 36 | +- [ ] Documentation has been added/updated for any new features |
| 37 | + |
| 38 | +### Configuration |
| 39 | + |
| 40 | +<!-- |
| 41 | + If you modified config.schema.json, you must regenerate types and docs: |
| 42 | + - npm run generate-config-types (regenerates src/config/generated-config-types.ts) |
| 43 | + - npm run gen-schema-doc (regenerates website/docs/configuration/reference.md) |
| 44 | +--> |
| 45 | + |
| 46 | +- [ ] If configuration schema (`config.schema.json`) was modified: |
| 47 | + - [ ] TypeScript types regenerated (`npm run generate-config-types`) |
| 48 | + - [ ] Schema reference docs regenerated (`npm run gen-schema-doc`) |
| 49 | + |
| 50 | +### Tests |
| 51 | + |
| 52 | +<!-- |
| 53 | + Tests are required for new functionality (80%+ patch coverage enforced by CodeCov). |
| 54 | + Add tests in the appropriate location: |
| 55 | + - test/ — Unit and integration tests (Vitest). Organised by module (processors/, db/, services/, plugin/, etc.) |
| 56 | + - tests/e2e/ — End-to-end tests (Vitest + Docker). Real git operations against a containerised environment. |
| 57 | + - cypress/e2e/ — UI tests (Cypress). Dashboard UI end-to-end tests. |
| 58 | +--> |
| 59 | + |
| 60 | +- [ ] Tests have been added/updated for new functionality |
| 61 | +- [ ] Unit tests pass (`npm test`) |
| 62 | +- [ ] Linting and formatting pass (`npm run lint` and `npm run format:check`) |
| 63 | +- [ ] Type checks pass (`npm run check-types`) |
0 commit comments