Skip to content

Add the new project/directory structure details to the documentation #114

Description

@dEhiN

In issue #108, a new project and directory structure was decided upon regarding naming conventions. Specifically, the summarization comment from that issue detailed the new structure:

So, to summarize everything decided upon for going forward:

GitHub Project Branch

This is what gets set when an issue is assigned to a project. For the project Repo: CompStart - which is the project set up for the CompStart repository - there will only be 3 branch labels used:

  1. branch-main
  2. branch-releases
  3. branch-qa-testing-debug

Git Repository Branch

This is a permanent branch that will always be part of the git repository for CompStart. There are three in use:

  1. main
  2. releases
  3. qa-testing-debug

Each of the three will have a one-to-one correspondence with the three GitHub Project Branch labels.

Git Development Branch

This is a temporary branch created to work on a GitHub issue. There is a specific naming convention that will be used for the branch name, consisting of a prefix, the forward-slash, the word "issue", and the issue number. The accepted prefixes are:

  1. features/
  2. documentation/
  3. refactor/
  4. release/
  5. debug/

Development branches with prefixes 1-3 will be based on the permanent branch main. Development branches with prefix 4 will be based on the permanent branch releases. Development branches with prefix 5 will be based on the permanent branch qa-testing-debug.

If an issue relates to or could fit under more than one prefix, judgement should be used to determine the best fit. When an issue is assigned to the project Repo: CompStart, the associated development branch will be based on one of the three repository branches. The issue should then be assigned the corresponding project branch label.

Project Directory Structure

This is the physical directory structure used for the repository. Depending on a development branch prefix, the work done on that branch may need to be contained to a specific folder:

  • features: Work done with this prefix should be contained to the folder /development/features with a new sub-folder created for the development branch.
  • debug: Work done with this prefix should be contained to the folder /development/qa-debug with a new sub-folder created for the development branch.
  • documentation: Work done with this prefix will most likely pertain to the Markdown files found in the folder /documentation. Therefore, a new sub-folder does not need to be created for the development branch.
  • release: Work done with this prefix will pertain to the content found in the folder /production. Therefore, a new sub-folder does not need to be created for the development branch.
  • refactor: Work done with this prefix could involve any and all content in the repository. Therefore, a new sub-folder does not need to be created for the development branch.

This issue has been created so the documentation can be updated. The above information either needs to go into README.md, TECHNICAL-DETAILS.md, or a new Markdown file, such as perhaps CONTRIBUTING.md.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomersproject-managementWork related to managing the project

Projects

Status
🆕 New

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions