search

goscommons / goscommons.github.io

Main repository of GO!Commons, where general guidelines, services, workflows and community organization takes place.
Other
9 stars 4 forks source link

different model conflicts in documentation #4

Closed rhythimashinde closed 6 years ago

rhythimashinde commented 6 years ago

what to do when there are different solutions that need to all be documented: for example, what happens when there are different microwaves models for instance?

rhythimashinde commented 6 years ago

One of the proposals can be: strict nomenclature of the branches. For example for the microwave models, nomenclature of the different branches can be as "model number - design number - project name". Here the model number can be decided based on the proposal timestamp. For example, the first branch would be "1-1-microwave", the second design proposal for the same model would be "1-2-microwave", the third design proposal for the same model would be "1-3-microwave". But if you want to propose a new model, then you will make a new branch "2-1-micorwave". Basically, look at the last created branch and name your branch based on model or design addition.

How will the master work here then? For every model, there will be a different folder in the master branch and only the finalised design branch for the model will be merged with the master.

Cherry-pick feature can help in specific design issues to be merged from different branches.

jurra commented 6 years ago

Great Reflections!

I would add some context for the current structure of the open-design-template repo. It was inspired by the open hardware repository.

They were talking about su-repos, subprojects. One of the difficulties could be when different hardware solutions are proposed. For instance this project: The pi microwave. The project also has a repository by the author.

Is a good case to study and see how it would fit in our open documentation model and standards. Because this are two sources of inspiration and examples, it would be nice to study them and reflect upon them.