Introduce dev command 'cheat sheets' #572
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
celinval
reviewed
Oct 20, 2021
zhassan-aws
reviewed
Oct 20, 2021
| So you don't have to worry about a series of "oops typo fix" messages while fixing up your pull request, these can be edited out of the final message when you click merge. | ||
|
|
||
| ```bash | ||
| # Set up your git fork |
Contributor
There was a problem hiding this comment.
Should we mention first creating your own fork on github?
rmc-docs/src/SUMMARY.md
Outdated
| - [Architecture diagrams]() | ||
| - [Code tour]() | ||
| - [Testing]() | ||
| - [Setting up a dev environment]() |
Contributor
There was a problem hiding this comment.
Would this include debugging? If not, can we add a subsection on debugging?
Contributor
Author
There was a problem hiding this comment.
Would you be willing to write that section? 😁
| --set=rust.deny-warnings=false | ||
| ``` | ||
| ```bash | ||
| # Done with that PR, time for a new one? |
Contributor
There was a problem hiding this comment.
Can we add a summary of the steps to submit a PR?
Contributor
Author
There was a problem hiding this comment.
I'm going to separate that out into a different section and PR.
adpaco-aws
reviewed
Oct 25, 2021
zhassan-aws
approved these changes
Oct 27, 2021
adpaco-aws
approved these changes
Oct 27, 2021
tedinski
added a commit
to tedinski/rmc
that referenced
this pull request
Apr 26, 2022
* Introduce dev command 'cheat sheets' * edits in response to feedback
tedinski
added a commit
that referenced
this pull request
Apr 27, 2022
* Introduce dev command 'cheat sheets' * edits in response to feedback
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
Introduce an initial set of command build or development commands, to aid our memory and onboarding for new developers.
Also outline some additional developer documentation we should add.
Testing:
How is this change tested?
Is this a refactor change?
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.