This page aims to document some of the tools you need to do your job as an engineer at Human Made.
Some things are required, but generally we try to be flexible about what you use. If you’re already happy with your development setup, you probably won’t need to change much. That said, documenting some commonly used tools and configurations is still important.
Essential Tools #
These are the key tools you’ll need for day-to-day development, so make sure you have access to these. You should be given access to these as part of your induction, but if not, ask your Engineering Manager! Make sure to enable two-factor authentication where possible.
- Laptop. Most people use Apple laptops, and much of the guidance here reflects this. You are free to choose an alternative, and we have some engineers who use Windows or Linux, but there may not be so much support available from the rest of the team. Join the slack channels #interests-linux or #interests-windows-os if you decide to use one of these platforms.
- Git & GitHub We use Github extensively, so you will need a github account. You’ll also need git installed on your computer.
- Slack. Probably the main way we communicate. Download the app on your laptop. Make sure to join #dev! Installing the app on your phone can be useful too, but be careful that you’re able to switch off at the end of the day!
- 1Password Password managers are good for security to ensure we use strong and unique passwords. We also use 1Password to share access to sensitive information across the company. You will need to be added to the ‘engineer’ group. Projects will often have their own group or vault that you will be given access to when you join.
- Zoom. Most of our meetings are on zoom.
- Running sites locally.
- Docker You will need this to run Altis local server and other modern WordPress local environments.
- Vagrant & Virtualbox. Some projects may recommend or require using a Vagrant based local development environment (e.g. those using Altis Local Chassis), for which you will need to use both Vagrant and Virtualbox.
- Node.js. You will need this to run most local build processes. We recommend installing Node using nvm so that it is easier to switch between different versions depending on your project.
- Code Editor. You’re free to use whatever you want to write code, but you’ll need something. Here are the most commonly used code editors at Human Made. See below for some tips.
- Terminal app.
- Web browser!
Also refer to the company handbook tools page for a reference on other tools used across the company.
There are other tools that may be essential for the project you’re working on (e.g. project management tools such as Jira), but you probably don’t need access to it until you actually need it. Individual projects will have their own onboarding process to ensure you have access to everything required when you join. However if you feel that you don’t have access to something that you should, don’t be afraid to ask.
Optional tools #
None of these tools are essential, but are things that engineers at Human Made use as part of their setup. You won’t need to install all of them right away, but take a look and you can install things as and when you need them.
- Database management application.
- Git GUI. Whilst we encourage you to become comfortable using git on the command line, sometimes having a nice interface is a huge help.
- MacOS
- Git merge tool
- MacOS
- API tool. Not essential, but can be really useful if you’re doing a lot of work with APIs.
Setting up your code editor #
VS Code #
Some useful settings and extensions.
- PHP Intelephense.
- PHP Debug
- PHP Sniffer & Beautifier. Also add
"phpcs.showSources": trueto your settings.json so that you can see the specific PHPCS rule that’s failing in theProblemstab message. - PHP Docblocker and Document This
- ESLint
- Stylelint
- WordPress snippets
- WordPress Gutenberg Snippets
- Gitlens
- Colorize bracket pairs for easier identification by adding
"editor.bracketPairColorization.enabled": trueto your settings.json. - Import cost or you can use Bundlephobia
PHP Storm #
To do.
How We Work #
This whole section of the handbook is about how Human Made works, and you should probably read all of it for a good overview. If you’re short of time, the key documents to read are the development process and review process pages.
We’re Here to Help #
Your manager and project team will help you get up to speed quickly, but everybody at Human Made is here to support you as well. If you see anything in these onboarding documents that doesn’t make sense or does not work for you — a broken link, an unfamiliar concept, something that looks outdated — don’t be afraid to ask questions!
You can ask questions in #general or #dev in Slack, message anybody directly, or join somebody’s office hours zoom. Please do not hesitate if you need assistance in any way.
We’re glad to have you on the team — welcome to Human Made!