Forum: Project organization: make code public and keep notes private
2
gravatar for A. Domingues
2.8 years ago by
A. Domingues1.6k
Mainz, Germany
A. Domingues1.6k wrote:

tl;dr: I want to put the code in github, but want to keep the notes taken during development private. How do people generally do it?

 

There are several papers/tutorials/books in which one can find best practices and practical suggestion on how to organize a bioinfo project. I am following most of those. For each project:

- a folder structures is created, data/docs/results/scripts;

- a markdown file or more detailing all the analysis, the fails, and some of the most important results;

- this put under version control (docs and scripts only) and hosted in bitbucket (private repos because unpublished ).

So far this system has served me well. However, I now have some scripts that could be useful for others, and it is only fair that I share those (github is my choice). This is easy enough to do, but I also have some notes (a markdown document) in the project folder, taken during development that I would rather keep under some form of version control, but not posted publicly. These contain failed approaches, musings, miscellaneous code, etc, that could be useful to figure out later why approach A was chosen, and B failed (am I the only one keeping this type notes?).

How do others do it? Keep a separate, local dev version? Keep notes somewhere else outside the project folder? Am I missing something?

This is not a question as such, since I am mostly interested in opinions on the practical ways that people use to develop and keep notes of (very) small tools/scripts that are made publicly available.   

ADD COMMENTlink modified 2.8 years ago by Istvan Albert ♦♦ 77k • written 2.8 years ago by A. Domingues1.6k
2
gravatar for Istvan Albert
2.8 years ago by
Istvan Albert ♦♦ 77k
University Park, USA
Istvan Albert ♦♦ 77k wrote:

I maintain a private git repository that has a separate directory for each project that has private information associated with it. 

ADD COMMENTlink written 2.8 years ago by Istvan Albert ♦♦ 77k

Cheers! Sounds reasonably easy and straightforward. 

ADD REPLYlink written 2.8 years ago by A. Domingues1.6k

I would also do the same. You can upload the private repo to github and bitbucket, and configure as another remote source. You can save all your private changes in a different branch, and push the branch only to this remote source.

ADD REPLYlink written 2.8 years ago by Giovanni M Dall'Olio26k
You can upload the private repo to github and bitbucket, and configure as another remote source.

Ah, something that did not occur to me: same project/folder in github and bitbucket

You can save all your private changes in a different branch, and push the branch only to this remote source. 

This is sound a tad more complicated, but time to read more about git. 

ADD REPLYlink written 2.8 years ago by A. Domingues1.6k
Please log in to add an answer.

Help
Access

Use of this site constitutes acceptance of our User Agreement and Privacy Policy.
Powered by Biostar version 2.3.0
Traffic: 1584 users visited in the last hour