-
Notifications
You must be signed in to change notification settings - Fork 3
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
108 readme join up with dfercreate project and update to be md files #123
Merged
Lsnaathorst1
merged 12 commits into
main
from
108-readme-join-up-with-dfercreate_project-and-update-to-be-md-files
Dec 11, 2024
Merged
108 readme join up with dfercreate project and update to be md files #123
Lsnaathorst1
merged 12 commits into
main
from
108-readme-join-up-with-dfercreate_project-and-update-to-be-md-files
Dec 11, 2024
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
3 tasks
jen-machin
reviewed
Nov 28, 2024
jen-machin
reviewed
Nov 28, 2024
jen-machin
reviewed
Nov 28, 2024
jen-machin
reviewed
Nov 28, 2024
jen-machin
reviewed
Nov 28, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overally looks really great! It's nice and clear and should be easy for people to use in their own work 😄
…nd-update-to-be-md-files
…o-be-md-files' of https://github.com/dfe-analytical-services/analysts-guide into 108-readme-join-up-with-dfercreate_project-and-update-to-be-md-files
jen-machin
previously approved these changes
Nov 28, 2024
jen-machin
reviewed
Dec 4, 2024
jen-machin
approved these changes
Dec 9, 2024
…nd-update-to-be-md-files
Lsnaathorst1
deleted the
108-readme-join-up-with-dfercreate_project-and-update-to-be-md-files
branch
December 11, 2024 09:41
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.
Overview of changes
Updating the README section to make more accurate and join up with DfE R. This will need a further update once the README template in DfE R is linkable.
Why are these changes being made?
Adding more information to each bullet point so people understand what should/could be included in a README. Referencing the create_project function in DfE R, so that people are aware they can create a new project including a README from there.
Detailed description of changes
Some changes to headings to make more publication specific. Information below each heading to describe what it should include. Addition of link to markdown guidance and link to DfE R. Changing .txt file to .md and describing why markdown files are good for READMES.
Issue ticket number/s and link
README - join up with dfeR::create_project() and update to be .md files #108
#108
This addresses the first two points on the issue above. I have made changes on DfE R to change to a template md file that can be linked here. Once this analysts guide guidance has been agreed and approved, I will need to amend the DfE R template to reflect this, and then link to the DfE R template directly here.
Checklist before requesting a review