0%

Book Description

Having learned their craft as a thought-intensive, independent activity, many web developers typically begin their careers by working as a team of one. Yet, in today’s dynamic workforce, web development is a highly social endeavor where developers collaborate with one another to build complex systems. This report provides guidelines for working effectively with other developers, particularly when it comes to making compromises, writing documentation, and interacting with open source in ways you can’t achieve as a solo learner.

Author Adam Scott explores widely accepted methods for writing quality code, contributing work to open source, improving your documentation practices, and—perhaps most critical—respecting and involving every member of your team. As part of the series on ethical web development, this report emphasizes how empathetic development practices like these will help you create empathetic products.

You’ll learn guidelines to help you:

  • Produce quality code by leveraging coding standards, version control, testing, and automated checks in a team environment
  • Release your project code as open source, complete with clear documentation and codes of conduct
  • Write useful code documentation that’s comprehensive, welcoming, and collaborative
  • Create an inclusive and safe environment for fellow developers, both at work and at group events
This is the fourth report in the Ethical Web Development series from author Adam Scott. Previous reports in this series include Building Web Apps for Everyone, Building Web Apps That Work Everywhere, and Building Web Apps that Respect a User's Privacy and Security.

Table of Contents

  1. Preface
    1. What Are Ethics?
      1. Professional Ethics
    2. Intended Audience
  2. 1. Introduction
    1. Our Responsibility
  3. 2. Code Quality
    1. Code Standards
      1. Community Standards Guidelines
      2. Automate Standards Compliance
    2. Version Control
    3. Testing
      1. Why Test At All?
      2. Unit Testing
      3. Browser and Functional Testing
      4. Test-Driven Development
    4. Automation
    5. Pair Programming
      1. Remote Pair Programming
    6. Code Reviews
      1. Guidelines for Everyone Involved in a Code Review
      2. Guidelines for Having Your Code Reviewed
      3. Guidelines for Reviewing Code
    7. Further Reading
  4. 3. Open Source
    1. Being an Open Source Maintainer
      1. Be Welcoming and Friendly
      2. Open Source Codes of Conduct
      3. Open Source Licenses
      4. Avoiding Maintainer Burnout
    2. Contributing to Someone Else’s Project
    3. Further Reading
  5. 4. Documentation
    1. The Eight Rules of Good Documentation
    2. The Importance of the README
      1. README Template
    3. Project Documentation
    4. When Developers Are Your Customers
    5. Wrapping Up
    6. Further Reading
  6. 5. Treating Other Developers with Respect
    1. Unconscious Bias
    2. Creating Welcoming Environments
    3. Further Reading
  7. 6. In Conclusion
3.143.9.115