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

README reformat and rewording to make it more concise #729

Merged
merged 2 commits into from
Jul 26, 2024
Merged

Conversation

ole4ryb
Copy link
Contributor

@ole4ryb ole4ryb commented Jul 26, 2024

What

Readme edition

Why

Some phrases can be reworded and some made more concise which looks better and takes less space.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Internal change (non-breaking change with no effect on the functionality affecting end users)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the Changelog with details of my change in the UNRELEASED section if this change will affect end users
  • A corresponding change has been made to the Mapping Documentation repository

@ole4ryb ole4ryb marked this pull request as ready for review July 26, 2024 14:47
README.md Outdated Show resolved Hide resolved
@ole4ryb ole4ryb enabled auto-merge (squash) July 26, 2024 15:35
@ole4ryb ole4ryb merged commit 4f49a70 into main Jul 26, 2024
1 check passed
@ole4ryb ole4ryb deleted the docs-improvement branch July 26, 2024 16:19
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.

2 participants