[UserStory] Development conventions

[jbae-89]

[UserStory] Development conventions

[jody]

It is unclear why the project Wiki needs to be where such documentation resides. This seems to overly constrain how the intent (rationale) is addressed.

[jody]

How does this relate to existing issue #24? Is this a component story and an indication that #24 should be labeled as an epic?

[BatchOfAllTrades]

@jody
The rationale behind using the wiki for the project conventions it is already a centralized location for project information as it relates to the development of project. This makes it an ideal location for development conventions to reside. Currently the wiki is not being used for more than a link to the project website which holds no more than project summary making it a relatively blank slate that can be utilized for more, and more valuable, information. Convention documentation can become quite lengthy especially in the case of this issue, as it covers more than just one convention topic.

We further propose adding a link to the wiki convention page from the README.md as to aid in clarity for all project contributors.

[jbae-89]

@jody
This is a request to expand and enhance documentation into the wiki making this a component of #24 . Issue #24 should be labeled as epic because it will be the broader scope of this issue.

[jody]

As discussed in person, a shortcoming of the Wiki is that it is not part of the repository. The Wiki seems most appropriate for information that may be dynamic or more temporal in nature as well as basic navigation for those who might turn to it upon first encountering the project.

Information about project conventions seems to warrant persistence within the development environment itself. This suggests embodying the information within the repository rather than in the Wiki.

[13Lena]

@jody
We propose making a folder within the project that contains multiple .md files. There is an existing .md file named DevelopmentConvension.md That would be updated as well as files with the subjects of contribution guidelines and dependency information added.

contributors to be updated:
@jbae-89 @BatchOfAllTrades @Xatziri @brianharrity @gapradhan

[jody]

Thank you!