Skip to content

Commit a0321ce

Browse files
authored
docs: added community-related documentation (#313)
* docs: added community-related documentation * updated governance file * ci: updated from wrapper-validation action v1 to v3
1 parent 7a83e7b commit a0321ce

File tree

8 files changed

+129
-3
lines changed

8 files changed

+129
-3
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Issue
2+
3+
Thank you for contributing. This project is community-driven and in low-maintenance mode; clear reports and PRs are highly appreciated.
4+
5+
## Type
6+
- [ ] Bug
7+
- [ ] Feature request
8+
- [ ] Question
9+
- [ ] Documentation
10+
11+
## Summary
12+
A concise description of the issue or request.
13+
14+
## Minimal Reproduction (for bugs)
15+
Provide a minimal, runnable example (link to a repo or paste the smallest code snippet) that reproduces the issue.
16+
17+
Steps to reproduce:
18+
1.
19+
2.
20+
3.
21+
22+
## Expected Behavior
23+
What you expected to happen.
24+
25+
## Actual Behavior
26+
What actually happened. Include stack traces or logs if relevant.
27+
28+
```
29+
<logs or stack trace>
30+
```
31+
32+
## Environment
33+
- graphql-java-annotations version:
34+
- graphql-java version:
35+
- Java version (e.g., 11.0.x):
36+
- Build tool (Gradle/Maven) and version:
37+
- OS:
38+
39+
## Proposed Solution (optional)
40+
If you have an idea or a potential fix, describe it here. PRs are welcome.
41+
42+
## Additional Context
43+
Add any other context, screenshots, or details here.
44+
45+
## Checklist
46+
- [ ] I searched existing issues and discussions for duplicates.
47+
- [ ] I included a minimal reproduction (for bugs).
48+
- [ ] I read the CONTRIBUTING.md and CODE_OF_CONDUCT.md.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Summary
2+
Explain what this PR changes and why.
3+
4+
## Type
5+
- [ ] Bug fix
6+
- [ ] Feature
7+
- [ ] Docs
8+
- [ ] Build/CI
9+
10+
## Checklist
11+
- [ ] Includes tests (or reason why not applicable)
12+
- [ ] Updates documentation if needed
13+
- [ ] Linked to issue: Fixes #____
14+
15+
## Notes for reviewers
16+
Anything specific to watch for?

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
steps:
1313
- uses: actions/checkout@v3
14-
- uses: gradle/wrapper-validation-action@v1
14+
- uses: gradle/actions/wrapper-validation@v3
1515
build:
1616
needs:
1717
- validation

CODE_OF_CONDUCT.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Code of Conduct
2+
3+
We follow the Contributor Covenant Code of Conduct.
4+
5+
- Be respectful and inclusive
6+
- Assume good intent
7+
- No harassment or discrimination
8+
9+
Incidents can be reported privately to the maintainers. Consequences may include warnings or bans from participation.

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing to graphql-java-annotations
2+
3+
Thank you for your interest in contributing!
4+
5+
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.
6+
7+
## Ways to help
8+
- Report bugs with a minimal reproduction (see issue template)
9+
- Improve documentation and examples
10+
- Add tests for uncovered areas
11+
- Small refactors and build improvements
12+
13+
## Coding guidelines
14+
- Follow existing style and conventions
15+
- Include unit tests for new behavior
16+
- Keep public API changes minimal; discuss major changes first in an issue
17+
18+
## PR process
19+
1. Open an issue or draft PR to discuss non-trivial changes
20+
2. Keep PRs small and focused
21+
3. Ensure tests are passing
22+
4. One maintainer approval is typically sufficient; we run monthly triage
23+
24+
## Commit messages
25+
- Clear and concise; reference issues like: “Fix: X (#123)”
26+
27+
## Release process
28+
- See RELEASE.md
29+
30+
## Community conduct
31+
- See CODE_OF_CONDUCT.md

GOVERNANCE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Governance
2+
3+
- Maintainers meet monthly to triage issues and PRs.
4+
- Due to limited time, we ask issue reporters to propose fixes via PR when possible.
5+
- Decisions are made by lazy consensus among maintainers; in case of disagreement, majority vote among maintainers.
6+
- Security issues: follow SECURITY.md.
7+
- Release cadence: as needed when changes accumulate.

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
![build](https://github.com/Enigmatis/graphql-java-annotations/actions/workflows/build.yml/badge.svg)
44
[![Maven Central](https://img.shields.io/maven-central/v/io.github.graphql-java/graphql-java-annotations.svg?maxAge=3000)]()
55

6-
[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
7-
syntax for GraphQL schema definition.
6+
[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.
87

98
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.
109

@@ -29,6 +28,7 @@ If you would like to use a tool that creates a graphql spring boot server using
2928
- [Mutations](#mutations)
3029
- [Connection](#connection)
3130
- [Customizing Relay Schema](#customizing-relay-schema)
31+
- [Community and Governance](#community-and-governance)
3232

3333
## Getting Started
3434

@@ -620,3 +620,13 @@ It has 2 methods:
620620

621621
For you convenience, there are two classes that you can use: `AbstractSimplePaginatedData` and `SimplePaginatedDataImpl`
622622
For examples, look at the tests
623+
624+
625+
## Community and Governance
626+
627+
We are community-driven and operate in a low-maintenance mode. If you’d like to get involved or understand how decisions are made:
628+
629+
- Contributing guide: see CONTRIBUTING.md
630+
- Governance: see GOVERNANCE.md
631+
- Code of Conduct: see CODE_OF_CONDUCT.md
632+
- Security: to report vulnerabilities, see SECURITY.md

SECURITY.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Security Policy
2+
3+
- Please do not open public issues for potential vulnerabilities.
4+
- Report security issues privately via GitHub Security Advisories (if enabled) or by emailing a maintainer.
5+
- We aim to acknowledge within 7 days and provide a timeline for fixes when possible.

0 commit comments

Comments
 (0)