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

Update README to match the Android project #17

Merged
merged 2 commits into from
Sep 6, 2023

Conversation

matt-livefront
Copy link
Collaborator

🚧 Type of change

  • 🎂 Other

📔 Objective

Updates the README to match the format that Android is using. This moves Setup above Dependencies and updates the dependency formatting.

Android README: https://github.com/bitwarden/android/blob/main/README.md

📋 Code changes

  • README.md: Updated to match Android.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@github-actions
Copy link
Contributor

github-actions bot commented Sep 5, 2023

1 Warning
⚠️ Total coverage less than 80%

Code coverage

Total coverage: 48.18%

Powered by Slather

Generated by 🚫 Danger

@bitwarden-bot
Copy link

bitwarden-bot commented Sep 5, 2023

Logo
Checkmarx One – Scan Summary & Details95b9a668-ea84-42e2-a4f0-6ba8ec2b9c3a

No New Or Fixed Issues Found

@matt-livefront matt-livefront merged commit 3427490 into main Sep 6, 2023
@matt-livefront matt-livefront deleted the matt/update-readme branch September 6, 2023 18:56
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