Skip to content

Latest commit

 

History

History
140 lines (91 loc) · 8.4 KB

CONTRIBUTING.md

File metadata and controls

140 lines (91 loc) · 8.4 KB
Raw

Contributing to Apollo Router

Before you contribute!

The Apollo Router is a project by Apollo GraphQL and is not currently ready for external feature contributors, though some documentation contributions may be accepted. We will try to publish a roadmap as soon as possible.

A general rule of thumbs is that if a contribution requires more than an 1 hour of work, chances are it's worth commenting on an issue and / or discussing it with the maintainers first.

That will allow us to figure out a way to solve the issue together, and possibly agree on what kind of PR would fix it best. Your time is valuable and we want to make sure you have the best contributors experience.

Setting up the project

The Apollo Router is written in Rust. In order to contribute, you'll need to have Rust installed. To install Rust, visit https://www.rust-lang.org/tools/install.

Rust has a build tool and package manager called cargo that you'll use to interact with the Apollo Router's code.

To build the CLI:

cargo build

To run the CLI:

cargo run -- <args>
# e.g. 'cargo run -- --help' will run the Apollo Router's help command

Refer to the README file or run cargo run --help for more information.

Project Structure

  • crates/apollo-router: the web Apollo Router sources. This includes everything required to expose Apollo Router's functionality as a web server, such as serialization / deserialization, configuration management, web server set up, logging configuration etc. As well as everything required to handle graphql queries:

    • query plan building
    • query plan execution
    • subservices fetching mechanism
    • response building
    • response streaming

  • crates/apollo-router/src/main.rs: the entry point for the executable

Some of the functionalities rely on the current Javascript / TypeScript implementation, provided by apollo federation, which is exposed through the federation router-bridge.

Documentation

Documentation for using and contributing to the Apollo Router is built using Gatsby and Apollo's Docs Theme for Gatsby .

To contribute to these docs, you can add or edit the markdown & MDX files in the docs/source directory.

To build and run the documentation site locally, you'll also need a clone of the apollographql/docs repository and run npm run start:router from there, after following installation instructions.

This will start up a development server with live reload enabled. You can see the docs by opening localhost:8888 in your browser.

Adding a new page to the documentation

If you're interested in adding new pages, head over to the creating pages section.

Documentation sidebar

To see how the sidebar is built and how pages are grouped and named, see this section of the gatsby-theme-apollo-docs docs.

Pipelines

This project uses Circle CI to run a continuous integration and delivery pipeline. Every code change will be run against a few steps to help keep the project running at its peak ability.

  • CLA Check: If you haven’t signed the Apollo CLA, a bot will comment on your PR asking you to do this

XTASKs:

  • Tests: The CI will run cargo xtask test which will test each relevant permutation of the available features and run the demo subgraphs.
  • Lints: The CI will check for lints and clippy compliance.
  • Checks: The CI will run cargo-deny to make sure the Apollo Router doesn't suffer an existing CVE, and that each dependency used by the Apollo Router is compatible with our license.

After you have opened your PR and all of the status checks are passing, please assign it to one of the maintainers (found in the bottom of the README who will review it and give feedback.

Code of Conduct

The project has a Code of Conduct that all contributors are expected to follow. This code describes the minimum behavior expectations for all contributors.

As a contributor, how you choose to act and interact towards your fellow contributors, as well as to the community, will reflect back not only on yourself but on the project as a whole. The Code of Conduct is designed and intended, above all else, to help establish a culture within the project that allows anyone and everyone who wants to contribute to feel safe doing so.

Should any individual act in any way that is considered in violation of the Code of Conduct, corrective actions will be taken. It is possible, however, for any individual to act in such a manner that is not in violation of the strict letter of the Code of Conduct guidelines while still going completely against the spirit of what that code is intended to accomplish.

Open, diverse, and inclusive communities live and die on the basis of trust. Contributors can disagree with one another so long as they trust that those disagreements are in good faith and everyone is working towards a common goal.

Bad Actors

All contributors to tacitly agree to abide by both the letter and spirit of the Code of Conduct. Failure, or unwillingness, to do so will result in contributions being respectfully declined.

A bad actor is someone who repeatedly violates the spirit of the Code of Conduct through consistent failure to self-regulate the way in which they interact with other contributors in the project. In doing so, bad actors alienate other contributors, discourage collaboration, and generally reflect poorly on the project as a whole.

Being a bad actor may be intentional or unintentional. Typically, unintentional bad behavior can be easily corrected by being quick to apologize and correct course even if you are not entirely convinced you need to. Giving other contributors the benefit of the doubt and having a sincere willingness to admit that you might be wrong is critical for any successful open collaboration.

Don't be a bad actor.

Code review guidelines

It’s important that every piece of code in Apollo packages is reviewed by at least one core contributor familiar with that codebase. Here are some things we look for:

  1. Required CI checks pass. This is a prerequisite for the review, and it is the PR author's responsibility. As long as the tests don’t pass, the PR won't get reviewed. To learn more about our CI pipeline, read about it below
  2. Simplicity. Is this the simplest way to achieve the intended goal? If there are too many files, redundant functions, or complex lines of code, suggest a simpler way to do the same thing. In particular, avoid implementing an overly general solution when a simple, small, and pragmatic fix will do.
  3. Testing. Please make sure that the tests ensure that the code won’t break when other stuff change around it. The error messages in the test should help identify what is broken exactly and how. The tests should test every edge case if possible. Please make sure you get as much coverage as possible.
  4. No unnecessary or unrelated changes. PRs shouldn’t come with random formatting changes, especially in unrelated parts of the code. If there is some refactoring that needs to be done, it should be in a separate PR from a bug fix or feature, if possible.
  5. Code has appropriate comments. Code should be commented describing the problem it is solving, not just the technical implementation. Avoid unnecessary comments if the code speaks well enough for itself.