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

[Ready to review] Designing a Repository chapter to add to project repo chapter #1930

Merged
merged 11 commits into from
Jun 26, 2021
Merged

Conversation

andreea-avramescu
Copy link
Collaborator

@andreea-avramescu andreea-avramescu commented May 19, 2021

Summary

Coauthors: Andreea Avramescu (@andreea-avramescu), Hannah Nicholls (@hlnicholls), Becki Green (@beckigreen)

Re-vamping the Research Compendia chapter into a 'Designing a Repository' chapter. The research compendia chapter could be updated, changing the terminology from compendia to focus on repository design - and updating the content to be specific to setting up a well organised repo.

List of changes proposed in this PR (pull-request)

  • Replace 'Research Compendia' chapter with 'Designing a Repository' chapter
  • Chapter content of 'Designing a Repository' to include sections:
    • Summary (outline chapter aims and prequisites)
    • Background (defining a repo)
    • Benefits
    • Main considerations
    • Example repo structure (both basic and more comprehensive)
    • Resources
    • Publications/further reading

What should a reviewer concentrate their feedback on?

  • Check writing for all chapter sections
  • Check that Benefits and Main considerations bullet points cover all points possible
  • Check example structures are comprehensive and easy to understand

Acknowledging contributors

@netlify
Copy link

netlify bot commented May 19, 2021

✔️ Deploy Preview for the-turing-way ready!

🔨 Explore the source changes: 92a661b

🔍 Inspect the deploy log: https://app.netlify.com/sites/the-turing-way/deploys/60d731a4cfd4330007532e61

😎 Browse the preview: https://deploy-preview-1930--the-turing-way.netlify.app

@beckigreen beckigreen changed the title Designing a Repository chapter to replace/update the Research Compendia chapter [WIP] Designing a Repository chapter to replace/update the Research Compendia chapter May 19, 2021
@beckigreen beckigreen added book-dash-may21 This Label is for Book Dash May 2021 related issues and PRs PR: unreviewed labels May 19, 2021
@beckigreen beckigreen changed the title [WIP] Designing a Repository chapter to replace/update the Research Compendia chapter Designing a Repository chapter to replace/update the Research Compendia chapter May 19, 2021
@beckigreen beckigreen changed the title Designing a Repository chapter to replace/update the Research Compendia chapter [Ready to review] Designing a Repository chapter to replace/update the Research Compendia chapter May 19, 2021
@malvikasharan malvikasharan changed the title [Ready to review] Designing a Repository chapter to replace/update the Research Compendia chapter [Ready to review] Designing a Repository chapter to replace Jun 26, 2021
@malvikasharan malvikasharan changed the title [Ready to review] Designing a Repository chapter to replace [Ready to review] Designing a Repository chapter to add to project repo chapter Jun 26, 2021
Copy link
Collaborator

@malvikasharan malvikasharan left a comment

Choose a reason for hiding this comment

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

Hi all, great work, I have reviewed and made some updates. It is nearly ready to merge.
I have moved this chapter to the project repo chapter where it fits in the advanced structure. I have included a few real examples of the project repo. Would you like to add more?

@malvikasharan
Copy link
Collaborator

@all-contributors please add @andreea-avramescu for content

@allcontributors
Copy link
Contributor

@malvikasharan

I've put up a pull request to add @andreea-avramescu! 🎉

@malvikasharan malvikasharan merged commit 97d3d6b into the-turing-way:master Jun 26, 2021
@welcome
Copy link

welcome bot commented Jun 26, 2021

Congratulations Banner
Congrats on merging your first pull request! 🎉 We here at The Turing Way are proud of you! 💖 Thank you so much for your contribution 🎁

@pr-triage pr-triage bot added the PR: merged label Jun 26, 2021
@malvikasharan
Copy link
Collaborator

@all-contributors please add @hlnicholls for content

@allcontributors
Copy link
Contributor

@malvikasharan

I've put up a pull request to add @hlnicholls! 🎉

@malvikasharan
Copy link
Collaborator

@all-contributors please add @beckigreen for content

@allcontributors
Copy link
Contributor

@malvikasharan

I've put up a pull request to add @beckigreen! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
book-dash-may21 This Label is for Book Dash May 2021 related issues and PRs PR: merged PR: reviewed-approved PR: unreviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants