Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: extend contribution guide #594

Merged
merged 1 commit into from
Jun 10, 2021
Merged

docs: extend contribution guide #594

merged 1 commit into from
Jun 10, 2021

Conversation

EverlastingBugstopper
Copy link
Contributor

@EverlastingBugstopper EverlastingBugstopper commented Jun 3, 2021 •
edited
Loading

Fixes (most of) #561, adds an ARCHITECTURE.md, and copies/extends the new command guide Jake started in #560.

TODO:

  • Auto-copy CONTRIBUTING.md to the Netlify docs with cargo xtask dist
  • How to build Rover from source
  • Move Code of Conduct section to CODE_OF_CONDUCT.md
  • Point folks to ARCHITECTURE.md and CODE_OF_CONDUCT.md from CONTRIBUTING.md
  • IDE/rust-analyzer tips
  • Local workflows
  • ARCHITECTURE.md:
    • how our crates work together
    • how we build for alpine (no composition)
    • how our error setup works
    • our thought process on command/flag creation language and how we expect future commands to follow that
    • documentation on rover client
  • Polish the new command guide

@EverlastingBugstopper EverlastingBugstopper added the docs 📝 improvements or additions to docs on the docs site label Jun 3, 2021
@EverlastingBugstopper EverlastingBugstopper modified the milestones: June 8, June 22 Jun 3, 2021
@EverlastingBugstopper EverlastingBugstopper force-pushed the avery/contribution branch 2 times, most recently from 6b137b4 to 44e73d4 Compare June 9, 2021 18:53
@EverlastingBugstopper EverlastingBugstopper changed the title wip: docs: extend contribution guide docs: extend contribution guide Jun 9, 2021
lrlna
lrlna reviewed Jun 10, 2021
View reviewed changes
ARCHITECTURE.md

An example of a clear need is the `graph` vs. `subgraph` vs. `supergraph` command structure. Each of these nouns has similar associated verbs.

Let's look at the `fetch` commands as an example. `rover graph fetch` and `rover subgraph fetch` each take a positional required `<GRAPH_REF>` argument, and `subgraph fetch` also has a required `--subgraph` flag. It really looks like there doesn't need to be differentiation between these commands. We could have made this behavior implicit by making `--subgraph` optional, and only returning a subgraph schema if the `--subgraph` argument was provided.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like this example!

lrlna
lrlna approved these changes Jun 10, 2021
View reviewed changes
Copy link
Member

@lrlna lrlna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow @EverlastingBugstopper this is really really good! Thank you ✨

@EverlastingBugstopper EverlastingBugstopper merged commit a8f0d76 into avery/xtask Jun 10, 2021
@EverlastingBugstopper EverlastingBugstopper deleted the avery/contribution branch June 10, 2021 14:50
EverlastingBugstopper added a commit that referenced this pull request Jun 10, 2021
@EverlastingBugstopper
docs: extend contribution guide (#594)
8a8202e
This was referenced Jun 21, 2021
Closed
Merged
@EverlastingBugstopper EverlastingBugstopper mentioned this pull request Jun 29, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lrlna lrlna lrlna approved these changes

@StephenBarlow StephenBarlow Awaiting requested review from StephenBarlow

Assignees
No one assigned
Labels
docs 📝 improvements or additions to docs on the docs site
Projects
None yet
Milestone
June 29
Development

Successfully merging this pull request may close these issues.
2 participants
@EverlastingBugstopper @lrlna