Fix #208, Add Writing High Quality Code #218
Merged
Conversation
This file contains 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
ArielSAdamsNASA
added
the
CCB:Ready
astrogeco
added
IC:2021-03-23
and removed
CCB:Ready
astrogeco
suggested changes
Mar 22, 2021
astrogeco
reviewed
Apr 1, 2021
| - Once successful, create a pull request. | ||
|
|
||
| For more information on our GitHub Action Workflows, view our [Security Policy](https://github.com/nasa/cFS/security/policy). | ||
|
|
||
| ## Getting Started |
There was a problem hiding this comment.
The getting started section probably needs a rename now since it isn't really about "getting started" anymore.
astrogeco
approved these changes
Apr 1, 2021
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Describe the contribution
Fix #208
Add Writing High Quality Code to the Contributing Guide
Expected behavior changes
Users should know how to write high quality code and how to use the GitHub Action Workflows.
Additional context
The Writing High Quality Code provides instructions for only the two static code analyzers used in GitHub Actions.
Should we add instructions for both Deprecated and OMIT_DEPRECATED Build, Test, and Run workflows? They only run when code is pushed to the main branch. If we want to add this, either the workflow needs to change so it is trigger for all branches or additional instructions must be provided for users so they can manually change the workflow files.
Contributor Info - All information REQUIRED for consideration of pull request
Ariel Adams, ASRC Federal