From 2acc1714fae4484f394dbd42d271351dba43df6e Mon Sep 17 00:00:00 2001 From: "Francois G." Date: Thu, 28 Aug 2025 10:46:53 +0200 Subject: [PATCH 1/3] docs: added community-related documentation --- .github/ISSUE_TEMPLATE.md | 48 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 +++++++++++ CODE_OF_CONDUCT.md | 9 ++++++ CONTRIBUTING.md | 31 +++++++++++++++++++++ GOVERNANCE.md | 10 +++++++ README.md | 14 ++++++++-- SECURITY.md | 5 ++++ 7 files changed, 131 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 GOVERNANCE.md create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..afd2aa26 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,48 @@ +# Issue + +Thank you for contributing. This project is community-driven and in low-maintenance mode; clear reports and PRs are highly appreciated. + +## Type +- [ ] Bug +- [ ] Feature request +- [ ] Question +- [ ] Documentation + +## Summary +A concise description of the issue or request. + +## Minimal Reproduction (for bugs) +Provide a minimal, runnable example (link to a repo or paste the smallest code snippet) that reproduces the issue. + +Steps to reproduce: +1. +2. +3. + +## Expected Behavior +What you expected to happen. + +## Actual Behavior +What actually happened. Include stack traces or logs if relevant. + +``` + +``` + +## Environment +- graphql-java-annotations version: +- graphql-java version: +- Java version (e.g., 11.0.x): +- Build tool (Gradle/Maven) and version: +- OS: + +## Proposed Solution (optional) +If you have an idea or a potential fix, describe it here. PRs are welcome. + +## Additional Context +Add any other context, screenshots, or details here. + +## Checklist +- [ ] I searched existing issues and discussions for duplicates. +- [ ] I included a minimal reproduction (for bugs). +- [ ] I read the CONTRIBUTING.md and CODE_OF_CONDUCT.md. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..9b777e69 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Summary +Explain what this PR changes and why. + +## Type +- [ ] Bug fix +- [ ] Feature +- [ ] Docs +- [ ] Build/CI + +## Checklist +- [ ] Includes tests (or reason why not applicable) +- [ ] Updates documentation if needed +- [ ] Linked to issue: Fixes #____ + +## Notes for reviewers +Anything specific to watch for? diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..4a1b5dda --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,9 @@ +# Code of Conduct + +We follow the Contributor Covenant Code of Conduct. + +- Be respectful and inclusive +- Assume good intent +- No harassment or discrimination + +Incidents can be reported privately to the maintainers. Consequences may include warnings or bans from participation. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..4a9584aa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing to graphql-java-annotations + +Thank you for your interest in contributing! + +Because maintainer time is limited, we prioritize contributions that come with a proposed fix. If you open an issue, please consider also opening a PR. We’re happy to guide you. + +## Ways to help +- Report bugs with a minimal reproduction (see issue template) +- Improve documentation and examples +- Add tests for uncovered areas +- Small refactors and build improvements + +## Coding guidelines +- Follow existing style and conventions +- Include unit tests for new behavior +- Keep public API changes minimal; discuss major changes first in an issue + +## PR process +1. Open an issue or draft PR to discuss non-trivial changes +2. Keep PRs small and focused +3. Ensure tests are passing +4. One maintainer approval is typically sufficient; we run monthly triage + +## Commit messages +- Clear and concise; reference issues like: “Fix: X (#123)” + +## Release process +- See RELEASE.md + +## Community conduct +- See CODE_OF_CONDUCT.md diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 00000000..307f27c2 --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,10 @@ +# Governance + +- Maintainers meet monthly to triage issues and PRs. +- Due to limited time, we ask issue reporters to propose fixes via PR when possible. +- Decisions are made by lazy consensus among maintainers; in case of disagreement, majority vote among maintainers. +- Security issues: follow SECURITY.md. +- Release cadence: as needed when changes accumulate. + +## Maintainers +- Listed in build metadata and CODEOWNERS; please @mention for reviews. diff --git a/README.md b/README.md index 3d1463dc..31cc9f7c 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ ![build](https://github.com/Enigmatis/graphql-java-annotations/actions/workflows/build.yml/badge.svg) [![Maven Central](https://img.shields.io/maven-central/v/io.github.graphql-java/graphql-java-annotations.svg?maxAge=3000)]() -[GraphQL-Java](https://github.com/graphql-java/graphql-java) is a great library, but its syntax is a little bit verbose. This library offers an annotations-based -syntax for GraphQL schema definition. +[GraphQL-Java](https://github.com/graphql-java/graphql-java) is a great library, but its syntax is a little bit verbose. This library offers an annotations-based syntax for GraphQL schema definition. If you would like to use a tool that creates a graphql spring boot server using graphql-java-annotations, you can view the [graphql-spring-annotations](https://github.com/yarinvak/graphql-spring-annotations) library. @@ -29,6 +28,7 @@ If you would like to use a tool that creates a graphql spring boot server using - [Mutations](#mutations) - [Connection](#connection) - [Customizing Relay Schema](#customizing-relay-schema) +- [Community and Governance](#community-and-governance) ## Getting Started @@ -620,3 +620,13 @@ It has 2 methods: For you convenience, there are two classes that you can use: `AbstractSimplePaginatedData` and `SimplePaginatedDataImpl` For examples, look at the tests + + +## Community and Governance + +We are community-driven and operate in a low-maintenance mode. If you’d like to get involved or understand how decisions are made: + +- Contributing guide: see CONTRIBUTING.md +- Governance: see GOVERNANCE.md +- Code of Conduct: see CODE_OF_CONDUCT.md +- Security: to report vulnerabilities, see SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..21cb91c7 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,5 @@ +# Security Policy + +- Please do not open public issues for potential vulnerabilities. +- Report security issues privately via GitHub Security Advisories (if enabled) or by emailing a maintainer. +- We aim to acknowledge within 7 days and provide a timeline for fixes when possible. From 27ecf41c357696bc49f8bbdad843b882b06bb89a Mon Sep 17 00:00:00 2001 From: "Francois G." Date: Thu, 28 Aug 2025 10:48:24 +0200 Subject: [PATCH 2/3] updated governance file --- GOVERNANCE.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 307f27c2..86a0ee19 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -5,6 +5,3 @@ - Decisions are made by lazy consensus among maintainers; in case of disagreement, majority vote among maintainers. - Security issues: follow SECURITY.md. - Release cadence: as needed when changes accumulate. - -## Maintainers -- Listed in build metadata and CODEOWNERS; please @mention for reviews. From 97d477b11cff4d0eb92ead4a8f5512f5e773f23a Mon Sep 17 00:00:00 2001 From: "Francois G." Date: Thu, 2 Oct 2025 11:06:35 +0200 Subject: [PATCH 3/3] ci: updated from wrapper-validation action v1 to v3 --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 5fc8de8a..959e2a27 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - uses: gradle/wrapper-validation-action@v1 + - uses: gradle/actions/wrapper-validation@v3 build: needs: - validation