About the Foundation for Public Code

How to publish About (merging develop into main)

This guide


  1. Goal
  2. Review process


The purpose of routinely merging develop into main is to make sure our website contains the newest, most accurate version of all of our information and to avoid big chunky merges. The purpose of reviewing these merges carefully is to make sure that we only publish high-quality and usable content on our website.

Review process

  1. Create a ‘release branch’ from ‘develop’, naming it ‘[date]+release’.
  2. Create a pull request from release branch into main.
  3. Include ‘review checklist template’ below as a comment on your pull request.
  4. Review all changes and additions. Small uncontroversial problems, such as typos, can be fixed in the release branch. For larger and/or controversial problems (such as restructuring of context), create a new branch and make a pull request into the release branch. For any open ended issues (such as new content suggestions), create an issue.
  5. Once review is complete, merge to main! :tada:
  6. If any changes were made to the release branch, make a pull request from main into develop. This ensures these changes will also be implemented in develop, keeping it up to date.

Our publishing process is based on GitFlow.

## Review checklist template

- [ ] All new files are linked in indices
- [ ] Front matter is present and correct
- [ ] Bullets and numbered lists are correct
- [ ] Correct Markdown and formatting
- [ ] All content reviewed