Learning how to work with serratus repo about serratus HOT 5 CLOSED

I accidentally committed to the master branch instead of my private developer branch. My mistake, still struggling to grok git, I do understand that I should have issued a pull request. The commit added a directory notebook/200422_rce with instructions how to run simulated Cov paired reads. I added my initials to the directory name because it seemed risky to use the date alone because otherwise another developer might use the same name.

from serratus.

I think solution here is to make one centrally defined CONTRIBUTING.md document for the repository, this way everyone on-boarding can access all necessary information in one place. Currently having a few README scattered and information across a bunch of Issues which is not intuitive. Let's plan out what we need to make this efficient and we're all on the same page. The main topics I can think of right now are below, what am I missing?

Serratus

• Description of bioinformatics pipeline
• Description of aws architecture

Repository organization

• Data
  -- CoV Pan-Genomes
  -- sraRunInfo Files
• Docker / Scripts
• Notebooks

Contributing

• Using Git/Github
• Finding an open Task
• Creating a new Task
• Running an experiment
• Accessing Data
• Depositing Data
• Report a bug / Suggest Feature

from serratus.

Hey @rcedgar,

I've put together a draft CONTRIBUTING document. Let me know if this clarifies things and/or gives you a good 'overview' of how to plug into the project. You're the target audience so any feedback is welcome because it'll be the same questions other people will have.

from serratus.

First glance this looks very helpful and an excellent first draft. I'm a bit overwhelmed with multiple projects right now, will try to give more / better feedback when I can.

from serratus.

That's fine Robert. For experiment entries I think not using a branch is OK, it's really for changes to production code, pipeline or containers that it's critical to branch. I'll close this for now, you can still comment if you have any information you'd like to be added to the CONTRIBUTING document.

from serratus.