Skip to content

Publishing process

Bryan Behrenshausen edited this page May 14, 2025 · 1 revision

The Open Source Way's project workflow is largely dependent on the functionality of the GitHub platform. GitHub is a web-based, distributed version control tool that enables content creators to build and collaborate on text-based creations (code, prose) wherever they can connect to the internet. Before beginning work on The Open Source Way, contributors must have a GitHub account. All work done on The Open Source Way will be done within the guidebook repository of the The Open Source Way organization. This work will be under the project's license.

Contributing to The Open Source Way

Contributing a new chapter to The Open Source Way is relatively straightforward when you are familiar with the well-documented GitHub platform. Contributors can write materials on any system, then propose them to the project via GitHub's web interface. Just follow these steps:

  1. Click Add file.
  2. Click Create new file.
  3. Add a file name in the name field.
  4. Copy the text into the Enter file contents here field.
  5. Click Commit changes.
  6. In the Commit new file section, add a short commit message.
  7. In the Extended description field, add a short message (considering including a reference to the issue associated with the chapter—for example, "per discussion in #XX").
  8. Click the Create a new branch for this commit and start a new pull request radio button. You can use the suggested branch name or create your own.
  9. Click Propose New File. The Open a Pull Request window will open.
  10. Click the gear icon in the Reviewers pane in the right column of the page.
  11. Choose the reviewer recommended to you upon initial consultation about the chapter.
  12. Click Create pull request.

This will submit your chapter for initial review. If it meets inclusion criteria, project maintainers will merge it into the project's main branch.

Reviewing a contribution to The Open Source Way

When reviewing materials drafted for The Open Source Way, reviewers should consult the style guide. Reviewers should leave comments in the file under review, inline where possible. Click the + button next to the line in question in order to leave a comment.

Editing a contribution to The Open Source Way

The Open Source Way editorial process consists of the following steps (or "phases"):

  1. Development edit
  2. Subject matter review
  3. Copy edit
  4. Technical edit

Each "editorial pass" requires a different form of editorial and subject matter expertise, but in each pass the general editorial workflow remains the same.

{TODO}

Clone this wiki locally