Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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.

```
<logs or stack trace>
```

## 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.
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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?
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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.
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 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.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand Down Expand Up @@ -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
5 changes: 5 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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.