Skip to content

Commit

Permalink
updating branch organization description
Browse files Browse the repository at this point in the history
  • Loading branch information
costero-e committed Aug 17, 2023
1 parent 8680e9f commit c09c3ef
Showing 1 changed file with 111 additions and 1 deletion.
112 changes: 111 additions & 1 deletion docs/code-organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,117 @@ Changes to the Markdown files in the `/docs` directory (and its children) will i

The `gh-pages` branch is generated from the `/docs` directory through its `mkdocs` workflow and contains the website itself. **Do not edit**

## Topic branches
## Hotfix branches

These are the branches that are meant to fix some bugs that break the specifications and need an urgent fix. The branches are directly deployed towards the `main` branch.

### `entry-type-definitions-cleanup`

This branch aims to redefine the wording of the entry types in a way that makes more clear what are the entry types. As the old definitions could mislead to some confusions, this is a sensible change that is needed to directly affect the current modification.

<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>

### `hotfix_filteringTermsResults`

As the beaconFilteringTermsResults.json "type" property of the FilteringTerm is ambiguous, this branch has the objective to fix this and make filtering terms object to be operative and ready to point to the filtering terms type.

<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>

### `schema-urgent-fixes`

Some of the instances of the schema were missing attributes and other aspects that are required to make a beacon work. This is mandatory to be urgently fixed and this is the purpose of this branch deployment.

<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>

## Feature and subfeature branches

The feature branches are the branches that bring a lot of changes together to change some specific part of the specifications. They can be composed by different subfeature branches that commit to them or just have one single working branch. The feature branches commit to the `develop` branch as they are the changes that will lead beacon to be upgraded to a new version. The subfeature branches commit to their parent feature branch, as they are a microchange of all the aspects that have to change in a new feature that is being developed. The branches are named as the main purpose of them, so it is made very clear what is the working area of them and the subfeature branches add the name of the feature branch they belong as a prefix followed by an underscore. The list of these feature branches with their subfeature branches is the one shown next:

### `clean-up`

#### `clean-up_sticky_modified_files`

<b>Current status:</b><span style="color:blue">Last commit by @jrambla.</span>

#### `clean-up_renaming_entity_to_entry_type`

<b>Current status:</b><span style="color:blue">Added in framework-refactor-entry-type-definitions branch by @mbaudis and waiting for a PR to be accepted.</span>

#### `clean-up_decouple-model-framework-refs`

<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>

#### `clean-up_move-CURIE-to-beaconCommonComponents`

<b>Current status:</b><span style="color:blue">This branch has not had any commit.</span>

#### `clean-up_de-snakify-token-names`

<b>Current status:</b><span style="color:blue">This branch has not had any commit.</span>

#### `clean-up_refactor-analysys-pipeline-info`

<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>

### `resultsets`

#### `resultsets_remove-requirement-results-resultsCount`

<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>

### `requestParameters`

#### `requestParameters_genomicVariations-fix`

<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>

#### `requestParameters_list-parameters-with-comma`

<b>Current status:</b><span style="color:blue">This branch has not had any commit.</span>

### `phenopackets`

#### `phenopackets_standards-alignment`

<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>

### `network`

#### `network_aggregator-and-networks-support`

<b>Current status:</b><span style="color:blue">This branch has not had any commit.</span>

#### `network_meta-add-aggregator-flag`

<b>Current status:</b><span style="color:blue">Last commit by @mbaudis.</span>

### `anyOf`

#### `anyOf_filteringTerms`

<b>Current status:</b><span style="color:blue">This branch has not had any commit.</span>

### `genomicVariations`

<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>

### `received-filters`

<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>

### `response-meta-add-warnings`

<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>

### `framework-refactor-entry-type-definitions`

<b>Current status:</b><span style="color:blue">Waiting for PR to be accepted.</span>







==TBD==

0 comments on commit c09c3ef

Please sign in to comment.