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): small fix and add notes to help out new users #597

Merged
merged 1 commit into from
Sep 19, 2023

Conversation

camilamacedo86
Copy link
Contributor

@camilamacedo86 camilamacedo86 commented Sep 18, 2023

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

  • Correct the command for executing the requirements.
  • Include two notes to guide new users and prevent potential issues.

Checklist

Optional. Add a 'x' to steps taken.
You can fill this out after opening the PR. "Did I..."

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@doanac
Copy link
Member

doanac commented Sep 18, 2023

@camilamacedo86 camilamacedo86 force-pushed the small-readme-improvements branch from 18992cf to 50479fe Compare September 18, 2023 17:42
@camilamacedo86 camilamacedo86 marked this pull request as ready for review September 18, 2023 17:43
@doanac
Copy link
Member

doanac commented Sep 18, 2023

@camilamacedo86 camilamacedo86 changed the title add notes to the readme to help out new users small nit fix and add notes to the readme to help out new users Sep 18, 2023
@camilamacedo86 camilamacedo86 changed the title small nit fix and add notes to the readme to help out new users small fix and add notes to the readme to help out new users Sep 18, 2023
@camilamacedo86 camilamacedo86 changed the title small fix and add notes to the readme to help out new users (readme): small fix and add notes to help out new users Sep 18, 2023
- Correct the command for executing the requirements.
- Include two notes to guide new users and prevent potential issues.
@camilamacedo86 camilamacedo86 force-pushed the small-readme-improvements branch from 50479fe to b6e5145 Compare September 18, 2023 17:47
@doanac
Copy link
Member

doanac commented Sep 18, 2023

@angolini angolini requested a review from a team September 18, 2023 20:57
Copy link
Collaborator

@angolini angolini left a comment

Choose a reason for hiding this comment

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

I would avoid using icons. But I will @kprosise decide about that. Other than that LGTM.

Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you for this!

@kprosise kprosise merged commit b9fe48f into foundriesio:main Sep 19, 2023
1 check failed
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.

4 participants