search

sashahafner / BMP-methods

Free, open-source documents on biochemical methane potential measurement and calculations
7 stars 7 forks source link

General approach for branches and revisions #15

Open sashahafner opened 4 years ago

sashahafner commented 4 years ago

This is a description of how I expect revisions etc. to work. Once it is finalized maybe I will include it and maybe other info in a README file.

There are two branches: master will be the public version, ideally without too many mistakes, and revising will be used for revisions. (By the way, branches are like copies, but of all the files not just one. And they can be merged together.) The main implication is that any time you want to edit a file, be sure to do it in the revising branch. If you are working directly in github.com, you can do it here:

image

Then to edit a file, click on it (typically the tex file, or csv for approval list, or txt, bib), the click on this pencil symbol to the right:

image

Edit, and then save your changes by "committing" them. You need to add at least a brief message explaining what you did, then click "commit":

image

Once we are done with a round of revisions in one or more documents, and ready to update the public versions, I will merge revising into master. All the Standard BMP Methods links point to the master branch, so this will automatically update the documents.

[Addition 18 March 2020]: We do not need to worry about updating version numbers until we are ready to merge into master.

[Addition 18 March 2020]: And note that converting tex to pdf will be done manually by me and @soweinrich, so the two will not always match (pdf may be behind).

@core, does it seem OK? Makes sense?

sastals commented 4 years ago

It does in theory! But do not remove the message so I can come back to it whenever I have to review a document

ChristofHolliger commented 4 years ago

I think I understand the main procedure, just have to get used to the news terms such as "branches", "committing", etc.

sashahafner commented 4 years ago

It does in theory!

Good.

But do not remove the message so I can come back to it whenever I have to review a document

You will always be able to find this under "Issues" (even if we "close" it). And once it is finalized I should make a better summary.

sashahafner commented 4 years ago

Just to clarify, the procedure described above (first comment) is for the core group only (also mentioned in issue #14).

soerenweinrich commented 4 years ago

Great - works for me!

koechl commented 4 years ago

I guess I got it. Still, Sasha and Sören will mainly handle this, so I will probably not do this too often.

sashahafner commented 4 years ago

@koechl you will make/propose revisions (edit tex files) but @soweinrich and I can create the pdfs from the tex files.