Skip to content

chore: add README files and repository review - #3

Merged
Vlad-Andres merged 4 commits into
mainfrom
feature/add-readme
Jul 3, 2026
Merged

Vlad-Andres merged 4 commits into
mainfrom
feature/add-readme

Conversation

@Vlad-Andres

@Vlad-Andres Vlad-Andres commented Jun 29, 2026 •

Copy link
Copy Markdown
Collaborator

Description

This PR introduces the README for current boilerplate and a template of the README that should be used by people who generate their own repository from the current template. Additionally, this PR should also be used for overall review of the repository template regarding the structure and folders relevance and adherence to good practices.

Changes

  • Add .github/README_TEMPLATE.md that contains a starting point for a new repos' README
  • Add main README of the current repository with the concise and simple usage instructions

Closes sodascience/Github_Manifest/issues/1

@Vlad-Andres Vlad-Andres changed the title feat: Add README and a template for README to facilitate utilisation of the boilerplate chore: add README files and repository review Jun 29, 2026

@fqixiang fqixiang left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Thanks for the work, Vlad. Please have a look at my comments and suggestions.

Comment thread .github/README_TEMPLATE.md Resolved
Comment thread .github/README_TEMPLATE.md Resolved
Comment thread .github/README_TEMPLATE.md Resolved
Comment thread .github/README_TEMPLATE.md Resolved
Comment thread .github/README_TEMPLATE.md Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
@Vlad-Andres
Vlad-Andres requested a review from fqixiang July 1, 2026 13:14

@fqixiang fqixiang left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hi Vlad, looks really good! Much improved from the last version. I left some minor comments.

Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
@Vlad-Andres
Vlad-Andres requested a review from fqixiang July 2, 2026 13:07

@Dutchmen04 Dutchmen04 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

PR looks good, the README might be a bit intimidating for new user but its better that its complete.

@fqixiang fqixiang left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks very good, Vlad!
I only had a few small comments. Once you've resolved them, feel free to go ahead and merge the PR without another round of review.

Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
Comment thread README.MD Resolved
@Vlad-Andres
Vlad-Andres merged commit 073a004 into main Jul 3, 2026
3 checks passed
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.

Investigate the feasibility of creating optional templates for all possible project types

3 participants