Skip to content
This repository has been archived by the owner on Apr 19, 2021. It is now read-only.

Repository Structure

Jump to bottom
Aaron Salyer edited this page Dec 19, 2017 · 2 revisions

Introduction

Many of the details of the way RevivalPMMP's repos are handled are being updated to create uniformity. Until these changes are finalized, the PureEntitiesX repository structure will adhere to the following guidelines:

General

  • Starting with v0.3.0, each release version will have its own branch when released.
  • Once a version is released into its own branch, that branch will only receive updates for security or compatibility.
  • No more than 3 version branches will be maintained for security or compatibility.
  • Typically, only the most recent release will be maintained.
  • RevivialPMMP or the PEX Dev Team will determine which version branches will receive updates. *When a new version is released, the previous version will enter a "Phase Out" period.

Releasing a New Version

New versions will start as a Project, Issue, or other documented list of desired features and/or necessary function changes. This list will be updated until RevivalPMMP or the PEX Dev Team decide to "Feature Lock" the version. The master branch will be used for all updates towards the next version. All features and functional changes should be developed in their own branch and a Pull Request submitted when the branch seems to be complete. Functional changes will receive priority over features when being merged into the master branch.

At no time should significant code changes happen directly on the master branch. Direct changes on the master branch should be for small changes such as API version bumps, grammar corrections, or the addition and/or removal of comments. All other significant changes will be developed in their own branch.

Once the final function or feature branch for a version is complete, all changes to master will stop long enough for the version to be finalized and released. This process should not take more than 7 days to complete under most circumstances. Steps to finalizing a version:

  • Determine Version Number
    • Versioning Will Follow Guidelines that are TBD
  • Create Version Branch with Appropriate Labels and Tags
Clone this wiki locally