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

docs: Add extra instruction to follow types list and improve README file #172

Merged
merged 5 commits into from
Nov 6, 2023

Conversation

adiati98
Copy link
Member

@adiati98 adiati98 commented Nov 6, 2023

Description

This PR holds following changes:

  • Added extra instruction to follow types list for manual entry.

  • Fixed and improved README with details as follow:

    • Added a banner for consistency throughout OpenSauced repos.
    • Added and fixed hyperlinks.
    • Improved wordings for clarity.
  • Changed asterisks to dashes in the i18n-guidelines.md for consistency throughout OpenSauced repos.

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Closes #171

Mobile & Desktop Screenshots/Recordings

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentation?

  • 📜 README.md
  • 📓 docs.opensauced.pizza
  • 🍕 dev.to/opensauced
  • 📕 storybook
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

@adiati98 adiati98 added the documentation Improvements or additions to documentation label Nov 6, 2023
@adiati98 adiati98 requested review from BekahHW and CBID2 November 6, 2023 10:36
@adiati98 adiati98 self-assigned this Nov 6, 2023
@adiati98 adiati98 enabled auto-merge (squash) November 6, 2023 10:37
Copy link
Contributor

@CBID2 CBID2 left a comment

Choose a reason for hiding this comment

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

LGTM

@adiati98 adiati98 merged commit 8053d71 into open-sauced:main Nov 6, 2023
@adiati98 adiati98 deleted the docs/improve-readme branch November 6, 2023 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Add extra instruction for manual entry and improve README
2 participants