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.

Sign up for GitHub

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

Jump to bottom

📘 Read.me – Adding content to improve F5 clarity, and project structure details #2248

Merged
merged 9 commits into from
Sep 26, 2024
Merged

📘 Read.me – Adding content to improve F5 clarity, and project structure details #2248

merged 9 commits into from
Sep 26, 2024

Conversation

isaaclombardssw
Copy link
Contributor

@isaaclombardssw isaaclombardssw commented Sep 25, 2024 •
edited
Loading

Self-explanatory, read the readme 😄

### General Contributing:

All New Content Submissions: (To be confirmed by reviewer)

  • Title is short & specific
  • Headers are logically ordered & consistent
  • Purpose of document is explained in the first paragraph
  • Procedures are tested and work
  • Any technical concepts are explained or linked to
  • Document follows structure from templates
  • All links work
  • The spelling and grammar checker has been run
  • Graphics and images are clear and useful
  • Any prerequisites and next steps are defined.

@vercel Vercel
Copy link

vercel bot commented Sep 25, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
tina-io 🛑 Canceled (Inspect) Sep 26, 2024 4:48am

@isaaclombardssw isaaclombardssw changed the title seeing if this fixes issues 📘 Read.me – Adding content to improve F5 clarity, and project structure details Sep 25, 2024
@isaaclombardssw isaaclombardssw marked this pull request as ready for review September 25, 2024 07:39
@isaaclombardssw isaaclombardssw requested a review from a team as a code owner September 25, 2024 07:39
@isaaclombardssw
Copy link
Contributor Author

@bradystroud as per our convo, move the little diagram to a _docs/ directory (link it from the readme) and add a definition of ready / definition of done document as well

@isaaclombardssw
Copy link
Contributor Author

Created #2251 for removing old guides stuff.

bradystroud
bradystroud requested changes Sep 26, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
bradystroud
bradystroud approved these changes Sep 26, 2024
View reviewed changes
Copy link
Member

@bradystroud bradystroud left a comment

Choose a reason for hiding this comment

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

LGTM
I'd make sure Gert agrees with DoD

Marxoz
Marxoz reviewed Sep 26, 2024
View reviewed changes
Copy link
Contributor

@Marxoz Marxoz left a comment

Choose a reason for hiding this comment

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

Some suggestions

_docs/Definition-of-Done.md Outdated Show resolved Hide resolved
_docs/Definition-of-Done.md Outdated Show resolved Hide resolved
_docs/Definition-of-Done.md Show resolved Hide resolved
isaaclombardssw and others added 4 commits September 26, 2024 14:35
@isaaclombardssw @Marxoz
Update _docs/Definition-of-Done.md
bce6b90 
Co-authored-by: Gert Marx [SSW] <gert.marx@marxoz.com>
@isaaclombardssw @Marxoz
Update _docs/Definition-of-Done.md
88ee4f9 
Co-authored-by: Gert Marx [SSW] <gert.marx@marxoz.com>
@isaaclombardssw @Marxoz
Update _docs/Definition-of-Done.md
ddf3a27 
Co-authored-by: Gert Marx [SSW] <gert.marx@marxoz.com>
@isaaclombardssw
mentioning node version numbers
6705704
@isaaclombardssw isaaclombardssw merged commit 74d239f into main Sep 26, 2024
4 checks passed
@isaaclombardssw isaaclombardssw deleted the upgrading-the-readme-v2 branch September 26, 2024 05:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Marxoz Marxoz Marxoz left review comments

@bradystroud bradystroud bradystroud approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@isaaclombardssw @bradystroud @Marxoz