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

108 readme join up with dfercreate project and update to be md files #123

Conversation

Lsnaathorst1
Copy link
Contributor

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

  • I have checked the contributing guidelines
  • I have checked for and linked any relevant issues that this may resolve
  • I have checked that these changes build locally
  • I understand that if merged into main, these changes will be publicly available

@Lsnaathorst1 Lsnaathorst1 linked an issue Nov 26, 2024 that may be closed by this pull request
3 tasks
@Lsnaathorst1 Lsnaathorst1 marked this pull request as ready for review November 26, 2024 14:09
RAP/rap-statistics.qmd Outdated Show resolved Hide resolved
RAP/rap-statistics.qmd Outdated Show resolved Hide resolved
RAP/rap-statistics.qmd Outdated Show resolved Hide resolved
RAP/rap-statistics.qmd Outdated Show resolved Hide resolved
Copy link
Contributor

@jen-machin jen-machin left a 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 😄

jen-machin
jen-machin previously approved these changes Nov 28, 2024
RAP/rap-statistics.qmd Outdated Show resolved Hide resolved
@Lsnaathorst1 Lsnaathorst1 merged commit 9201cf0 into main Dec 11, 2024
1 check passed
@Lsnaathorst1 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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README - join up with dfeR::create_project() and update to be .md files
2 participants