Guidelines for Freelance Developers Working with Me

I’ve been hiring software developers and other freelancers for the past seven years. Even though I write most code myself, hiring other developers is a tremendous force multiplier that frees up time for other parts of my business.

Freelancers work well if you manage the relationship properly, but there are hundreds of ways it can go wrong. The best way to start things off is by reaching a shared understanding of your freelancer-client relationship.

The document below explains what it’s like to work with me as a freelance developer. I include it in every dev job listing I publish, and I pay contractors to read it closely after we begin working together. It attracts candidates with compatible working styles and reduces ramp-up time after I hire them.

I’m publishing my guidelines under the Creative Commons BY-4.0 license, so you’re welcome to reuse or adapt them.

Overview ?︎

This document explains the processes and conventions I use when working with freelance developers.

If you’re reading this document before working with me, feel free to skim it to see if this working style matches yours. If you’re reading it while on an active contract with me, read it thoroughly and bill me for the time.

Golden rule ?︎

I want to treat you how I’d like to be treated.

Communication ?︎

I value effective communication above all else.

Err on the side of overcommunication. When sharing a solution, it’s helpful to hear why you chose it and what other avenues you explored.

Resolve emails quickly ?︎

I communicate primarily over email.

My email style is what Cal Newport describes as “process-centric." In short, emails usually represent a task or a question, and we’re aiming to resolve it with as few back-and-forths as possible. This requires us both to compose emails thoughtfully rather than firing off the quickest response that clears the thread from our inbox.

Bad Email Sequence ?︎

The following is a fictional example of a poor email sequence. Instead of investing time up front to think about the information they need, the freelancer dribbles out questions one by one.

Freelancer: What format do you prefer for the image? PNG or JPEG?

Freelancer: What size should it be?

Freelancer: Should it rescale on smaller devices?

Me: Yes, it should be 400x300px on viewports smaller than 768px.

Good Email Sequence ?︎

In contrast, this email sequence answers the same questions as above, but in a planned, efficient way.

Freelancer: I’d love your input on the image. Can you let me know your preferences on the following?

  • Format (PNG or JPEG)?
  • Size (in pixels)?
  • Should it rescale on smaller devices?

Me: Thanks for the well-thought-out questions!

  • The format should be PNG.
  • On viewports smaller than 768px, the size should be 400x300px. Otherwise, the size should be 800x600px.

Email response time ?︎

I expect responses to emails within one business day. In other words, if I email you at 3pm on a Tuesday, I expect a response by 3pm Wednesday. If you don’t have a complete answer, respond to acknowledge the message and provide an ETA for the full response.

It’s okay for response time to run longer than one day occasionally, but it should be the exception and not the rule. Expect the same from me.

Meetings ?︎

Meetings are useful for topics that are inefficient or impossible to communicate in writing. They come at a significant cost — meetings interrupt focus and constrain schedules, so I keep them to a minimum.

I use emails to communicate facts and meetings to discuss opinions. For example, if we review a design document, we don’t need to read it together live. Instead, we can read the document beforehand and reserve the meeting time for interactive discussion.

I’ll also schedule meetings once or twice a month for casual face-time together. Email-only communication can make things feel impersonal and tense.

Discussion Topic Notes
“Can we schedule a meeting to discuss the deadline for this project?” BAD: This is a simple question that doesn’t require a meeting.
“It’s going to be hard for you to review my next pull request. Can we meet so I can explain it to you?” BAD: If the code is too complicated to understand, a meeting is not the answer.
“I have an idea for a new architecture. Can we hop on a call to go over it?” BAD: I’d rather start with a written explanation and then discuss after I’ve read it.
“Your design document calls for us to use Postgres, but I’d like to understand the constraints and talk about other options.” GOOD: This is a complicated decision that likely requires many little back-and-forths, so a live discussion will be more efficient than email.
“You’ve given me feedback in code reviews about ‘cohesion,’ but I feel like we’re still not quite on the same page. Can we meet to discuss it?.” GOOD: If we’ve tried to communicate something in writing, and it’s not working, a meeting is an excellent way to hash it out.

Interviews ?︎

I never conduct formal interviews to make a hiring decision.

I’ll ask to see examples of previous work, or I may ask a few questions over email, but I’m primarily interested in how well we work together. If you’re a strong candidate, I’ll set up a narrowly-scoped job at your regular pay rate. People generally refer to this style as “contract-to-hire.”

If I ask you to begin a paid trial assignment, I’ll pay for your time even if we decide not to work together afterward. The only exception is if you fail to make a good-faith effort on the assignment (e.g., you bill ten hours on a programming task and deliver zero code).

Due Diligence ?︎

Freelancers provide the most value when they minimize my time overseeing their work. This requires due diligence before reaching out with questions.

You should feel comfortable asking for help, but I expect you to answer questions on your own where possible. If you’re unable to solve the problem, let me know how you’ve tried.

Bad Questions

  • How do I install Flask on my computer?
  • How do I link to specific sections of a Google Doc?
  • What significance does the number 443 have in our server configuration?

Good Questions

  • I’m having trouble understanding section 3 of the spec. Does “client” refer to the end-user or a client of the API?
  • When I try to install your software, I get the error message FooBarBaz. I’ve re-read the installation guide and searched the open issues, but I can’t figure out what’s going wrong. Do you know what the problem is?

Availability ?︎

I don’t expect anyone to be available more than five days per week. Unless you tell me otherwise, I’ll assume you don’t work on weekends.

I don’t work weekends or major US holidays. You’re welcome to email me on the weekend, but I won’t respond until the next business day. I try to avoid email before noon in US Eastern Time.

You’re free to work whichever hours you like, but I’d like you to have some overlap with my working hours, which are 10am-6:30pm ET.

I don’t expect you to work a fixed schedule each week, but the more I can predict your hours, the easier it is to prepare tasks and feedback that coincides with your availability.

Feedback ?︎

It’s common for me to ask for feedback during or after a project. Freelancers have valuable ideas for improving processes or work dynamics, but they sometimes don’t feel comfortable sharing until they’re asked directly.

My questions are generally:

  • Are there changes that would make the work smoother or more enjoyable?
  • Are there types of work you want to do more of? Less of?

Deadlines ?︎

I rarely need work urgently, so I generally allow you to set your own deadlines. You’re responsible for meeting your deadlines without reminders from me.

Don’t allow deadlines to sail by without an update. If you tell me to expect work by 3pm ET Tuesday, it causes me stress if I don’t see anything from you by Tuesday night. I’ll wonder if you completely forgot the task and you’ll have to start from scratch or if you’re almost done and will deliver results in a few hours.

If you’re going to miss a deadline, let me know. The earlier you warn me about a schedule slip, the better. The absolute latest you should be telling me about a delay is the deadline itself.

In general, delays are not a big deal as long as I can plan around them. If a deadline is important to me, I’ll let you know.

When specifying deadlines, use precise, unambiguous time conventions:

  • Pretty Good: I’ll send it to you by EOD Friday
  • Better: I’ll send it to you by 5pm ET on Dec. 8th.
  • Bad: I’ll have it ready in the next few days.
  • Terrible: I’ll let you know when it’s ready.

Timeboxing ?︎

Early in our work together, I’ll ask you to limit billable hours per week or milestone. I do this to control billing as I get a sense of your development velocity and whether we work well together.

If you’re approaching the limit and won’t finish, reserve time to organize the work you’ve done. Send it to me in an email with an explanation of what’s complete, what’s incomplete, and how many hours you expect for the remaining work.

I won’t pay for any time beyond the agreed hours cap.

As we work together more, I’ll increase or eliminate the time cap to give you more autonomy.

Documentation ?︎

I value documentation highly.

If a project has documented processes or Github templates, please follow them. If the documentation tells you to do something that seems incorrect, let me know. Don’t assume that instructions are out of date or not meant for you.

When you begin working with me on a project, you become the new owner of its ramp-up documents. If you got stuck because something was documented poorly or not at all, please submit edits to fill the gaps.

Thoughtfully document the code that you write. Aim to make the code self-documenting, but include source comments for information that code can’t express. Comment new code with roughly the same thoroughness as nearby code.

# Number of days per week (seven) <-- BAD comment
DAYS_PER_WEEK = 7 # This is a workaround for a bug in FooComponent, which crashes the process
# if we call it immediately after writing to disk. <-- GOOD comment
time.sleep(5)

Code quality ?︎

I value quality and maintainability over turnaround time.

Once you have working code, look for opportunities to simplify or refactor the logic and make it more intuitive. If it takes you twice as long to make your code 30% simpler, that’s a net positive for me.

Code reviews ?︎

I thoroughly review all code changes and provide detailed feedback.

My comments are not meant to criticize you or make you feel bad. I review rigorously to understand the code and bring it to a state where I can maintain it long-term.

These articles explain my code review process:

Code style ?︎

My projects adhere to Google’s code style guidelines:

As much as possible, I use automated tools to enforce style conventions.

Git ?︎

I use Git for source control. You don’t need to be a Git expert as long as you understand basic functionality:

  • Clone a repo
  • Create a branch
  • Make a commit
  • Push and pull changes
  • Rebase a commit (occasionally)

Github permissions ?︎

I assign access on a least-privilege basis. If you’re working on one of my public repositories, you can clone it and begin making pull requests with no additional permissions.

I use two Github integrations that require annoyingly broad permissions: CircleCI and Reviewable. Both applications require write access to all repos in your Github account. If you don’t feel comfortable with those permissions, you’ll need to create a dedicated Github user account for your work with me so that you can grant those tools full access.

Commit hygiene ?︎

Some developers believe that every commit is beautiful and sacred. I’m not one of them.

It’s important to me that the main branch has a sane commit history. In all other branches, commit however you like. You can make one commit per code review note or address all notes in a single commit. Whatever workflow you prefer is fine with me. I use Github’s squash and merge functionality, so every pull request collapses down to a single commit.

If you submit a pull request with many commits, I’ll read the pull request title, description, and comments. I don’t dig through the individual commits, as I assume they represent your intermediate work. The article “How to Write a Git Commit Message” describes my preferred style of documenting contributions, except applied to the pull request, not the individual commits.

Testing ?︎

When you create a pull request, you’re responsible for ensuring all tests pass in continuous integration. Fix any build breaks before sending me code to review.

If you’ve added a feature or otherwise changed behavior, update the automated tests to exercise the new behavior.

If you’ve modified a feature that’s difficult to test with automation, manually test the functionality to exercise the new code. If you can’t find a way to do that, warn me that it’s untested when you send it for review (this should be extremely rare).

Billable hours ?︎

I consider almost everything you do in service of working with me to be billable work.

Examples of billable work

  • Communicating with me (including emails, video calls, and in-person meetings)
  • Reading documents that I ask you to read (including this one)
  • Researching a technique or technology relevant to your work
  • Going for a walk to think about a complex problem

Examples of non-billable work

  • Reading a book cover-to-cover because it’s related to your work
    • Reading a chapter is fine.
  • Fixing your work computer because your hard drive died
  • Shopping for a new desk chair

Expenses ?︎

I expect you to provide the basic tools you need to operate as a freelance developer (e.g., computer, Internet access, electricity).

I’m happy to pay the cost of any software, services, or equipment that make your work more efficient or pleasant. Just run it by me first.

If I ask you to purchase something related to the job, I’ll reimburse you for it on your next invoice.

Monitoring ?︎

I trust you to report your hours honestly. I’ll never ask you to “prove” your hours to me or install any surveillance software on your system.

If we’re on a platform such as Upwork, where monitoring is built-in, I’ll always make the monitoring features optional. I won’t review the monitoring data unless there’s an egregious discrepancy in hours. Even in that case, I’ll speak to you before inspecting the data.

It’s difficult to specify exactly how frequently to share updates, as there’s a degree of judgment required.

For tasks where the scope is obvious, like feature work that’s well-understood, share an update once every eight to ten hours of billable work. For tasks where the scope is variable, such as bug investigations or features that require experimentation, aim to update once for every two to four hours of billable work. The absolute upper-limit on time without a status update should be three calendar days of billable work or 10 billable hours, whichever happens first.

The best way to share status update is with pull requests that reflect progress. Ideally, you can peel off a part of your work that makes a complete pull request, but if not, you can share a pull request and mark it as “draft” to indicate it’s still a work in progress. To share progress during a bug investigation, update the Github issue summarizing what you’ve investigated and what you’ve learned.

You can email me privately for meta-discussions about the work that you prefer not to share widely on Github, but try to keep as much discussion as possible on Github.

Payment ?︎

Please send me invoices for your hours every two weeks. Expect payment within five business days of the invoice, usually sooner.

I don’t pay bonuses or tips. I want your compensation to be transparent, so you don’t have to wonder about undefined pay left to my discretion.

I pay via PayPal, Payoneer, ACH transfer (US only), or a mailed check (US only), depending on your preference.

Post-contract work ?︎

I’ll never contact you after a job with questions about your work or requests for free changes. It’s my responsibility to determine that you delivered everything I requested within your time under contract.

If I discover an issue in your work after I send you payment, I’m responsible for fixing it myself or offering you additional billable hours.

Taxes ?︎

If I pay you more than $600 per calendar year, I need some forms for tax purposes.

  • US citizens and residents
    • You’ll need to provide a W-9 form. At the end of the year, I’ll send you a 1099-MISC.
  • Non-US freelancers
    • I’ll need a W-8BEN form that declares you don’t owe US taxes.

Intellectual property ?︎

If we’re working together on a project where I want to retain intellectual property rights, I’ll send you a contract to e-sign. It declares that I’m purchasing the copyright to the code you write for me.

The contract relates specifically to work I pay you to produce, not anything you create outside of your paid hours for me.

Cover art by Loraine Yow.

Are you a client or freelancer? I’d love to see similar documents or hear how others approach this problem, so feel free to share in the comments.

I've been hiring developers and other freelancers for the past seven years. One of the best ways to attract strong candidates is by setting clear expectations about the work, so I'm sharing the guidelines I use when hiring. What are yours? https://t.co/G4sScVllEL

— Michael Lynch (@deliberatecoder) March 12, 2021

首页 - Wiki
Copyright © 2011-2024 iteam. Current version is 2.137.1. UTC+08:00, 2024-11-23 02:20
浙ICP备14020137号-1 $访客地图$