Update Tools page #643
Open
Update Tools page #643
+67
−90
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying contributing-docs with
|
| Latest commit: |
bd76a24
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d3bcf354.contributing-docs.pages.dev |
| Branch Preview URL: | https://update-tools-page.contributing-docs.pages.dev |
|
Great job! No new security vulnerabilities introduced in this pull request |
Thomas-Avery
reviewed
Aug 4, 2025
docs/getting-started/tools/index.md
Outdated
| | [Git](https://git-scm.com) | [Commit signing](../../contributing/commit-signing.mdx) is strongly recommended. | | ||
| | [Homebrew](https://brew.sh/) | Package manager for macOS. | | ||
| | [Iterm2](https://iterm2.com/) | A better terminal emulator (available via Homebrew). | | ||
| | [NodeJS](https://nodejs.org/) | Check the `engines` in [package.json](https://github.com/bitwarden/clients/blob/main/package.json) for the current version. We recommend using a [node version manager][nvm]). | |
There was a problem hiding this comment.
Suggested change
| | [NodeJS](https://nodejs.org/) | Check the `engines` in [package.json](https://github.com/bitwarden/clients/blob/main/package.json) for the current version. We recommend using a [node version manager][nvm]). | | |
| | [NodeJS](https://nodejs.org/) | Check the `engines` in [package.json](https://github.com/bitwarden/clients/blob/main/package.json) for the current version. We recommend using a [node version manager][nvm]. | |
Hanging )
There was a problem hiding this comment.
Thank you for catching that. I updated it with bd76a24.
withinfocus
requested changes
Aug 5, 2025
|
|
||
| ## Recommended tools | ||
|
|
||
| The following tools are strongly recommended as part of the “standard” developer setup. We recommend | ||
| The following tools are strongly recommended as part of the "standard" developer setup. We recommend |
There was a problem hiding this comment.
🎉 So glad we catch these awful magic quotes that rich editors sneak in.
| @@ -4,118 +4,95 @@ sidebar_position: 1 | |||
|
|
|||
| # Tools | |||
There was a problem hiding this comment.
❓ What's the context of Bitwarden vs. non here? Is this whole page worthy of hiding behind the check?
| | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | ||
| | [JetBrains Rider](https://www.jetbrains.com/rider/download/) | Fully featured IDE for C#, .NET & more. Bitwarden developers should contact IT for a license. | | ||
| | [Visual Studio](https://visualstudio.microsoft.com/) | Used for C# development on Windows. | | ||
| | [Visual Studio Code](https://code.visualstudio.com/) | Used for all Typescript projects. Suboptimal for C#. Be sure to install [extensions](#visual-studio-code-extensions). | |
There was a problem hiding this comment.
Suggested change
| | [Visual Studio Code](https://code.visualstudio.com/) | Used for all Typescript projects. Suboptimal for C#. Be sure to install [extensions](#visual-studio-code-extensions). | | |
| | [Visual Studio Code](https://code.visualstudio.com/) | Used for all TypeScript projects. Be sure to install [extensions](#visual-studio-code-extensions). | |
Not sure how much commentary to leave since this is a move, but I would avoid the opinionated language.
"Typescript" should be fixed everywhere.
| | [JetBrains Rider](https://www.jetbrains.com/rider/download/) | Fully featured IDE for C#, .NET & more. Bitwarden developers should contact IT for a license. | | ||
| | [Visual Studio](https://visualstudio.microsoft.com/) | Used for C# development on Windows. | | ||
| | [Visual Studio Code](https://code.visualstudio.com/) | Used for all Typescript projects. Suboptimal for C#. Be sure to install [extensions](#visual-studio-code-extensions). | | ||
| | [Xcode](https://developer.apple.com/xcode/) | Required for iOS Mobile development and Safari web extension. | |
There was a problem hiding this comment.
Suggested change
| | [Xcode](https://developer.apple.com/xcode/) | Required for iOS Mobile development and Safari web extension. | | |
| | [Xcode](https://developer.apple.com/xcode/) | Required for iOS development and the Safari web extension. | |
| | [Docker](https://docs.docker.com/get-docker/) | Required for server development only. Bitwarden developers should contact IT for a license for Docker Desktop. | | ||
| | [Git](https://git-scm.com) | [Commit signing](../../contributing/commit-signing.mdx) is strongly recommended. | | ||
| | [Homebrew](https://brew.sh/) | Package manager for macOS. | | ||
| | [Iterm2](https://iterm2.com/) | A better terminal emulator (available via Homebrew). | |
There was a problem hiding this comment.
ℹ️ Is this tool widespread?
| | [JetBrains Rider](https://www.jetbrains.com/rider/download/) | Fully featured IDE for C#, .NET & more. Bitwarden developers should contact IT for a license. | | ||
| | [Visual Studio](https://visualstudio.microsoft.com/) | Used for C# development on Windows. | | ||
| | [Visual Studio Code](https://code.visualstudio.com/) | Used for all Typescript projects. Suboptimal for C#. Be sure to install [extensions](#visual-studio-code-extensions). | | ||
| | [Xcode](https://developer.apple.com/xcode/) | Required for iOS Mobile development and Safari web extension. | |
There was a problem hiding this comment.
💭 Maybe just move to the mobile-specific tooling section?
| | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- | | ||
| | [Microsoft Azure Storage Explorer](https://azure.microsoft.com/en-us/features/storage-explorer/) | For connecting to or working with local Azure table storage and queues. | | ||
| | [MSSQL VSCode Extension](https://marketplace.visualstudio.com/items?itemName=ms-mssql.mssql) | For working with your local SQL Server. | | ||
| | [MySQLWorkbench](https://www.mysql.com/products/workbench/) | Useful for fiddling with MySQL db. | |
There was a problem hiding this comment.
Suggested change
| | [MySQLWorkbench](https://www.mysql.com/products/workbench/) | Useful for fiddling with MySQL db. | | |
| | [MySQL Workbench](https://www.mysql.com/products/workbench/) | Useful for fiddling with MySQL db. | |
| | [Microsoft Azure Storage Explorer](https://azure.microsoft.com/en-us/features/storage-explorer/) | For connecting to or working with local Azure table storage and queues. | | ||
| | [MSSQL VSCode Extension](https://marketplace.visualstudio.com/items?itemName=ms-mssql.mssql) | For working with your local SQL Server. | | ||
| | [MySQLWorkbench](https://www.mysql.com/products/workbench/) | Useful for fiddling with MySQL db. | | ||
| | [PgAdmin4](https://www.pgadmin.org/) | Useful for fiddling with PostgreSQL db. | |
There was a problem hiding this comment.
Suggested change
| | [PgAdmin4](https://www.pgadmin.org/) | Useful for fiddling with PostgreSQL db. | | |
| | [PgAdmin4](https://www.pgadmin.org/) | Management of PostgreSQL databases. | |
Apply the same language for each below. Prior phrasing with "fiddling" is awkward to me.
| | -------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | ||
| | C# | [.NET Core Test Explorer](https://marketplace.visualstudio.com/items?itemName=formulahendry.dotnet-test-explorer) | Test explorer for .NET tests. | | ||
| | C# | [.NET Core User Secrets](https://marketplace.visualstudio.com/items?itemName=adrianwilczynski.user-secrets) | Edit secrets files by right clicking on a .proj and selecting "Manage User Secrets". | | ||
| | C# | [C#](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) | Omnisharp integrations. | |
There was a problem hiding this comment.
Suggested change
| | C# | [C#](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) | Omnisharp integrations. | | |
| | C# | [C#](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) | OmniSharp integrations. | |
| | General | [Back & Forth](https://marketplace.visualstudio.com/items?itemName=nick-rudenko.back-n-forth) | Adds forward and back buttons to top right of your editor. Simple, but incredibly useful. | | ||
| | General | [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | Can be annoying, but has saved lots of `tmes form writting oragnizations.` | | ||
| | General | [LiveShare](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare) | For pair programming. | | ||
| | Git | [Git Graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph) | Fantastic git visualization tool. | |
There was a problem hiding this comment.
Suggested change
| | Git | [Git Graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph) | Fantastic git visualization tool. | | |
| | Git | [Git Graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph) | Fantastic Git visualization tool. | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📔 Objective
The Tools page had become stale, which was evident in some questions we had from new engineers joining the team. I've updated the page to use tables instead of bullets so that it opens up the content and makes it easier to navigate.
I also alphabetized the entries and verified that all links are still active.
Once merged, I plan to archive the internal Confluence tools page as duplicative, as this page includes all the tools there.
⏰ Reminders before review
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 confirmedissue 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