Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 3.15 KB
Raw

Contributing to SwiftGraphQL

Hey 👋! This library is a collaborative effort of many people and we are all very excited to see you here. This file will help you navigate around more easily and make sure your pull requests receive attention they deserve.

If you have any questions about the library or just want to share ideas, feel free to reach out to Matic at matic.zavadlal [at] gmail.com or @maticzav on Twitter.

Roadmap

Feel free to contribute in any way possible. We are excited about your ideas and want to share them with the rest of the world. It's often even more helpful to write a well documented idea than to write code because "code is the easy part".

We are currently investing our efforts into

  • setting up a Swift Docc reference of the library,
  • building an exchange that handles normalized caching,
  • building an exchange for GraphQL subscriptions over SSE,
  • creating better SwiftUI bindings,
  • creating a type generator for queries in .graphql files.

If you decide to contribute in any of these topics, you'll' get a lot of attention and have top priority.

Code Organization

SwiftGraphQL is split into multiple packages that serve different purposes.

  1. GraphQL contains the structures that appear in all GraphQL requests,
  2. GraphQLAST describes the models and methods used for fetching information about the schema,
  3. GraphQLWebSocket implements a GraphQL over WebSocket protocol,
  4. SwiftGraphQL is a query builder library,
  5. SwiftGraphQLCodegen generates methods that you may use to build type-safe queries,
  6. SwiftGraphQLCLI exposes a ready to use CLI tool for code generation.

This package is best developed using Swift command line tools.

Creating a Pull Request

Every PR should follow a common structure. This way, it's easier for people to navigate the code, look back at the PRs and understand why library has evolved the way it has.

Every PR should follow the next set of guidelines

  1. Title should be well-formated (e.g. "Add WebSocket Support for Apple Watch", not "add WS for apple watch").
  2. The first comment should clearly outline what you've changed and, if necessary, why.
  3. Make sure that comments in the PR and in the code are grammatically correct.
  4. Check all your changes in GitHub files tab before again before requesting a review.
  5. Suggest a release type (e.g. patch, minor, major) for your change.

You can test the generators by running

swift run swift-graphql http://localhost:4000/graphql

Building Binary and Documentation

swift build -c release --product swift-graphql --disable-sandbox

You can run the following two scripts to regenerate APIs for both examples.

swift run swift-graphql https://api.github.com/graphql --config examples/GitHubStars/swiftgraphql.yml --output examples/GitHubStars/GitHubStars/GraphQL/API.swift  --header "Authorization: bearer TOKEN"

swift run swift-graphql http://localhost:4000/graphql --config examples/thesocialnetwork/ios/TheSocialNetwork/swiftgraphql.yml --output examples/thesocialnetwork/ios/TheSocialNetwork/Shared/GraphQL/API.swift