gestionar la documentation del proyecto en un repository git

Actualmente estoy trabajando en un proyecto con algunas personas y me preguntaba cuál podría ser la mejor forma de compartir la documentation de nuestro proyecto. Estaba pensando en agregar el documento en algunas carpetas y agregarlo en git, pero realmente no sé cómo hacerlo de la manera adecuada …

Intentamos seguir este procedimiento para nuestro repository de git: http://nvie.com/posts/a-successful-git-branching-model/

Creo que es una forma bastante común de administrar un git repo: master para las versiones, desarrollar para las próximas características, una twig por function … pero no veo ninguna manera de include y trabajar en el documento con este model. ¿Debo crear una twig específica para el documento? ¿Debo presionarlo para desarrollarlo y luego fusionarlo nuevamente cada vez en las twigs de características? Estoy un poco perdido…

Gracias por tu ayuda 🙂

Es probable que desee que la documentation de una característica se fusione al mismo time que la function en sí. Para mí, eso sugiere que debes trabajar en la documentation en cualquier twig que estés editando el código.

Por lo tanto, sugeriría tener un directory de documentos (como lo describió en su pregunta) y actualizarlo en su twig de características. De esta forma, si decide no fusionar la característica, entonces no fusiona accidentalmente la documentation que la acompañó.

No tiene mucho sentido hacerlo en la twig de desarrollo porque es una twig de integración. Por lo tanto, espera fusionar las cosas allí, pero no el desarrollo real (incluida la documentation de escritura) allí.

¿Debo crear una twig específica para el documento?

Si quieres decir crear una twig que solo contenga documentation, entonces no, creo que es una mala idea. Es útil poder tener el código y la documentation probados al mismo time, y eso es más difícil si necesita verificar dos twigs.

Si quiere decir crear una twig específica para trabajar en la documentation, entonces sí, probablemente. Si llama a la documentation una característica, entonces podría tener sentido usar una twig de function (o algo similar de un nombre diferente).