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.

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

Rework 07 and 11 #157

Merged
merged 3 commits into from
Sep 20, 2024
Merged

Rework 07 and 11 #157

merged 3 commits into from
Sep 20, 2024

Conversation

kellijohnson-NOAA
Copy link
Collaborator

What is the feature?

Attempted to make the collaborative workflow easier to maintain and understand by only holding the most relevant information.

How have you implemented the solution?

  • Removed from sections from 07
  • Removed the glossary in favor of putting links in the introduction to C++ for developers
  • Added note for Windows users running GoogleTests

Does the PR impact any other area of the project, maybe another repo?

NO

@cmlegault I chose you as a reviewer because you contributed to #144 and did not want sections removed so I am trying to make sure that I did not remove too much from the guide. Thanks.

* Removes "Roadmap to FIMS File Structure and Organization" info will be put in README files in each folder eventually, see NOAA-FIMS/FIMS#650
* Removes section on "Merge Conflicts" given the 3-1 vote for removing it in #144
* Removes section on "GitHub Actions Results" because it is a button that is visible from the top of the repository and this information is not specific to FIMS
* Removes "GitHub Teams" because we are not using them
* Moves "Commit Messages" to style guides
* Remove hard-coded wrap on lines
Thanks to @bai-lee-noaa for letting me know when things were not working for me.
rather than using the glossary

Closes #144
Copy link
Collaborator

@cmlegault cmlegault left a comment

Choose a reason for hiding this comment

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

Thanks Kelli, I approve these changes. I like the new links for learning C++ you've added. I'm fine with the sections you've removed, many were either not providing much information or were too far in the weeds to be truly useful. You've done a nice job balancing the need for information with the desire to keep the amount of information manageable.

@kellijohnson-NOAA
Copy link
Collaborator Author

Thanks Chris!

@kellijohnson-NOAA kellijohnson-NOAA merged commit 51783a7 into main Sep 20, 2024
1 check passed
@kellijohnson-NOAA kellijohnson-NOAA deleted the rework-07 branch September 20, 2024 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants