graphql / graphql/graphql.github.io
Create naming best practices page
- Dominant language
- TypeScript
- Stars
- 889
- Forks
- 1.5k
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 21
Description
Naming is always the hardest thing but there are some established conventions for naming in the GraphQL community, see:
* https://benjie.dev/graphql/naming
* https://www.apollographql.com/docs/graphos/schema-design/guides/naming-conventions
Other languages also have their own code style/conventions:
* [Rust](https://doc.rust-lang.org/nightly/style-guide/)
* [Kotlin](https://kotlinlang.org/docs/coding-conventions.html)
* [Go](https://go.dev/doc/effective_go)
Feels like having official guidance on graphql.org would be a win for the community.
Contributor guide
Research direction
Start by reviewing the GraphQL naming guidance and the linked conventions for GraphQL, Rust, Kotlin, and Go. Then inspect the graphql.org documentation structure to determine where the page belongs; done means a published naming best practices page with agreed, clearly organized guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- graphql
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100