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

TASK: Tweak README #5137

Merged
merged 3 commits into from
Jun 13, 2024
Merged

TASK: Tweak README #5137

merged 3 commits into from
Jun 13, 2024

Conversation

kdambekalns
Copy link
Member

@kdambekalns kdambekalns commented Jun 11, 2024

This converts the Readme.rst to Markdown and splits it into two separate files, README.md and CONTRIBUTING.md as is convention these days.

Checklist

  • Code follows the PSR-2 coding style
  • Tests have been created, run and adjusted as needed
  • The PR is created against the lowest maintained branch
  • Reviewer - PR Title is brief but complete and starts with FEATURE|TASK|BUGFIX
  • Reviewer - The first section explains the change briefly for change-logs
  • Reviewer - Breaking Changes are marked with !!! and have upgrade-instructions

This converts the `Readme.rst` to Markdown and splits it into two
separate files, `README.md` and `CONTRIBUTING.md` as is convention
these days.
@kdambekalns
Copy link
Member Author

kdambekalns commented Jun 11, 2024

TODO:

@ahaeslich
Copy link
Member

I guess you want to address the checklist in follow up PRs?

@kdambekalns
Copy link
Member Author

I guess you want to address the checklist in follow up PRs?

🤷

What would be the best way to "connect" the READMEs of the dist and collection repositories?

CONTRIBUTING.md Outdated Show resolved Hide resolved
@kdambekalns
Copy link
Member Author

I guess you want to address the checklist in follow up PRs?

I guess improving the dev dist readme is a different task…

Copy link
Member

@mhsdesign mhsdesign left a comment

Choose a reason for hiding this comment

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

Thanks, i guess the catchup trigger changes snuck in somehow because your base branch was stale?

@kdambekalns
Copy link
Member Author

Thanks, i guess the catchup trigger changes snuck in somehow because your base branch was stale?

Could be, yes.

@kdambekalns kdambekalns merged commit 9b78eee into neos:9.0 Jun 13, 2024
10 checks passed
@kdambekalns kdambekalns deleted the task/tweak-README branch June 13, 2024 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants