You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**Prevent update checker from aborting commands - [EverlastingBugstopper], [pull/624]**
30
-
31
-
Previously, if there was a spurious network error when attempting to check for a newer version of Rover, the command would fail. This is no longer the case, if GitHub is down, you will still be able to run Rover commands.
-**New `cargo xtask` command suite - [EverlastingBugstopper], [issue/388][pull/562]**
46
-
47
-
We've replaced a decent chunk of bash scripting in GitHub actions with Rust code. This means you can locally run most commands you need for contributing to Rover with `cargo xtask`.
-**Extend contribution guide and create an architecture document - [EverlastingBugstopper], [JakeDawkins] & [StephenBarlow], [issue/561][pull/594]**
56
-
57
-
Our new architecture document includes a guide on how to add a new command to Rover, and the `CONTRIBUTING.md` file at the root of the Rover repository is automatically included on our documentation site.
Copy file name to clipboardexpand all lines: docs/source/contributing.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ To build and run the CLI with a set of arguments:
40
40
cargo run -- <args>
41
41
```
42
42
43
-
For example, to build and run `rover supergraph compose`:
43
+
e.g. To build and run `rover supergraph compose`:
44
44
45
45
```bash
46
46
cargo run -- supergraph compose --config config.yaml
@@ -94,21 +94,21 @@ The Rover team primarily uses [VS Code](https://code.visualstudio.com/) along wi
94
94
95
95
The Rover team works largely in public using GitHub [issues] to track work. To make sure contributions are aligned with the project's goals, keep the following issue etiquette in mind:
96
96
97
-
*[Open an issue](https://github.com/apollographql/rover/issues/new/choose) for your contribution. If there is already an issue open, please ask if anyone is working on it or let us know you plan on working on it. This will let us know what to expect, help us to prioritize reviews, and ensure there is no duplication of work.
98
-
* Use issue templates! These templates have been created to help minimize back-and-forth between creators and the Rover team. They include the necessary information to help the team triage your issue or question, as well as automatically applying the appropriate labels.
99
-
* Issues with the `triage` label still applied have not yet been reviewed by the Rover team, and there are no guarantees that PRs fixing an untriaged issue will be accepted. It's best to wait for issues to be triaged before beginning work.
97
+
1.[Open an issue](https://github.com/apollographql/rover/issues/new/choose) for your contribution. If there is already an issue open, please ask if anyone is working on it or let us know you plan on working on it. This will let us know what to expect, help us to prioritize reviews, and ensure there is no duplication of work.
98
+
1. Use issue templates! These templates have been created to help minimize back-and-forth between creators and the Rover team. They include the necessary information to help the team triage your issue or question, as well as automatically applying the appropriate labels.
99
+
1. Issues with the `triage` label still applied have not yet been reviewed by the Rover team, and there are no guarantees that PRs fixing an untriaged issue will be accepted. It's best to wait for issues to be triaged before beginning work.
Pull requests (PRs) should only be opened after discussion and consensus has been reached in a related issue, and you have communicated your intentions to create a PR with the Rover team.
106
106
107
-
* When creating a PR, make sure to link it to an issue or use the `Fixes #123` syntax to make sure others know which issue(s) your PR is trying to address and to help us automatically close resolved issues.
108
-
* Include a helpful description. It is important to provide context to reviewers that show _how_ your PR addresses an issue and any questions you still have unanswered, or portions of the code you think deserve some extra attention.
109
-
* If your work is still in-progress and you're opening a PR to get early feedback, let us know by opening it as a draft PR and adding `wip:` prefix in the PR title.
110
-
* Add tests for any logic changes in your code, especially if you are fixing a bug. Your PR should have no failing tests before merging. Please let us know if you need help writing tests, there are still some portions of the Rover codebase that do not have established testing patterns.
111
-
* Add a changelog entry in [CHANGELOG.md](https://github.com/apollographql/rover/blob/main/CHANGELOG.md) under the `Unreleased` heading, following the pattern of previous entries.
107
+
1. When creating a PR, make sure to link it to an issue or use the `Fixes #123` syntax to make sure others know which issue(s) your PR is trying to address and to help us automatically close resolved issues.
108
+
1. Include a helpful description. It is important to provide context to reviewers that show _how_ your PR addresses an issue and any questions you still have unanswered, or portions of the code you think deserve some extra attention.
109
+
1. If your work is still in-progress and you're opening a PR to get early feedback, let us know by opening it as a draft PR and adding `wip:` prefix in the PR title.
110
+
1. Add tests for any logic changes in your code, especially if you are fixing a bug. Your PR should have no failing tests before merging. Please let us know if you need help writing tests, there are still some portions of the Rover codebase that do not have established testing patterns.
111
+
1. Add a changelog entry in [CHANGELOG.md](https://github.com/apollographql/rover/blob/main/CHANGELOG.md) under the `Unreleased` heading, following the pattern of previous entries.
112
112
113
113
### Documentation
114
114
@@ -132,7 +132,7 @@ To see how the sidebar is built and how pages are grouped and named, see [this s
132
132
133
133
To read about Rover's architecture, and to see a guide on how to add new commands, please see our [Architecture document](https://github.com/apollographql/rover/blob/main/ARCHITECTURE.md).
134
134
135
-
## Code of conduct
135
+
## Code of Conduct
136
136
137
137
The project has a [Code of Conduct] that *all* contributors are expected to
138
138
follow. This code describes the *minimum* behavior expectations for all
@@ -154,7 +154,7 @@ Open, diverse, and inclusive communities live and die on the basis of trust.
154
154
Contributors can disagree with one another so long as they trust that those
155
155
disagreements are in good faith and everyone is working towards a common goal.
156
156
157
-
## Bad actors
157
+
## Bad Actors
158
158
All contributors to tacitly agree to abide by both the letter and spirit of the
159
159
[Code of Conduct]. Failure, or unwillingness, to do so will result in
160
160
contributions being respectfully declined.
@@ -173,4 +173,4 @@ that you *might* be wrong is critical for any successful open collaboration.
173
173
174
174
Don't be a bad actor.
175
175
176
-
[Code of Conduct]: https://github.com/apollographql/.github/blob/main/CODE_OF_CONDUCT.md
176
+
[Code of Conduct]: https://github.com/apollographql/.github/blob/main/CODE_OF_CONDUCT.md
Copy file name to clipboardexpand all lines: docs/source/getting-started.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ To install a specific version of Rover (note the `v` prefixing the version numbe
20
20
> Note: If you're installing Rover in a CI environment, it's best to target a specific version rather than using the latest URL, since future major breaking changes could affect CI workflows otherwise.
21
21
22
22
```bash
23
-
curl -sSL https://rover.apollo.dev/nix/v0.1.7| sh
23
+
curl -sSL https://rover.apollo.dev/nix/v0.1.5| sh
24
24
```
25
25
26
26
You will need `curl` installed on your system to run the above installation commands. You can get the latest version from [the curl downloads page](https://curl.se/download.html).
@@ -38,7 +38,7 @@ To install a specific version of Rover (note the `v` prefixing the version numbe
38
38
> Note: If you're installing Rover in a CI environment, it's best to target a specific version rather than using the latest URL, since future major breaking changes could affect CI workflows otherwise.
0 commit comments