Engineering Management Handbook

An open-source book on leadership in software engineering. This repository not only houses the content but also the scripts and automation tools to generate various formats of the book (website, epub, physical book format, etc.).

Structure

• /book: Primary content of the book organized by sections or chapters.
• /scripts: Scripts used for tasks such as converting the book to different formats or linting.
• /assets: Global assets such as images, stylesheets, or other media referenced in the book.
  • /assets/images: Images used in the book.
  • /assets/epub-metadata.xml: Metadata for the epub format.
• /.github/workflows: GitHub Action workflows for CI/CD purposes.
• /dist: Contains the built versions of the book in various formats (automatically generated folder).

Contribution Guidelines

We welcome contributions! Whether you're fixing typos, suggesting improvements, or adding new content, your efforts are appreciated. Before contributing, please review our STYLE_GUIDE.md to ensure consistency and clarity across the book.

1. Fork the Repository: Start by forking this repository to your account.
2. Clone Your Fork: Clone your fork to your local machine.
3. Create a New Branch: For every change, especially new contributions, create a new branch.
4. Make Changes: Add your content or make modifications.
5. Push and Create a Pull Request: Push your changes to your fork and then create a pull request. Please provide a clear description of your changes in the PR.

Building the Book

If you wish to build the book locally:

1. Install pandoc
2. Navigate to the root directory.
3. Run the build script:

   ./scripts/build.sh

4. Check the /dist directory for the generated formats.

Continuous Delivery

This repository uses GitHub Actions to automatically build and publish the book as epub. The workflow is triggered on every push to the main branch. The workflow is defined in (.github/workflows/build.yml)[.github/workflows/build.yml].

Versioning is done automatically by assembling the day & time of the build. For example, a build on August 19, 2023 at 1:47 PM would be versioned as v2023.08.19.13.47.

License

The license for this project is not yet determined. Please refer to the license github issue for more information.