Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 6.49 KB

CONTRIBUTING.md

File metadata and controls

66 lines (42 loc) · 6.49 KB
Raw

How to contribute?

First of all, thanks for taking the time to contribute! 🎉👍

Your contributions are important to make this project and event successful. You can report mistakes and errors, propose a project, offer dataset and resources or create more content.

Whatever is your background, there is a way to contribute on this GitHub repository, on our mailing list, other related projects listed on our wiki page or via slack conversations.

You can raise any issue relevant to this project/event publicly in the mailing list (google group), we will address and/or assess your change proposal as promptly as we can to make your participation easier.

We have a Code of Conduct that applies to all the activities and projects involved in this event.

For any organisation related queries or concern, you can directly reach out to the organisers Leyla Garcia (email: ljgarciaco@gmail.com), Pjotr Prins (email: pjotr.public708@thebird.nl) and Tazro Ohta (email: t.ohta@dbcls.rois.ac.jp).

  • With such a large group of participants, we are encouraging a bottom-up approach, where groups are formed around projects/topics and work (kind of) independently from others.
  • If you need any information from another group/topic, you can always reach people via email or slack (please note that as the hacking starts, Slack might become more interactive, you can also directly ping people there, be patient please and re-ping if needed or look for an alternative contact).
  • Every group/topic will have leader/coordinator/facilitator, please check the wiki to get more information (as we get close to the hacking week, we expect the wiki to change quickly and people to add more group/topic details there).
  • We also expect group/topic leaders/coordinators/facilitators to provide a quick (daily if possible) summary via the wiki so everybody can get an idea on it.

How can I participate at this event?

Join the Google group mailing list and the virtualbiohackathoncovid19 slack and join the conversation! No approval needed.

How can I join the hackathon?

  • Please have a look at the GitHub wiki to see the existing projects.
  • When you’ve found a project you’d like to contribute to, do a quick scan to make sure that the project is suitable for accepting contributions.
  • Commonly, channels are created on our Slack workspace, so please have a look there to see if the group/topic you are interested in is already there.
  • If there is no channel, go to "general" slack channel or COVID-19 Google group mailing list and raise a question on how to join that group/topic/project. Members working on that project would help you participate.

How can I fix something on the repository?

  • Raise mistakes, error or missing information on this repository by opening a Pull Request
    • Submit trivial fixes (for example, a typo, a broken link or an obvious error)
    • Start work on a contribution that was already asked for, or that you’ve already discussed, in a mailing list
    • A pull request doesn’t have to represent finished work. It’s usually better to open a pull request early on, so others can watch or give feedback on your progress. Just mark it as a “WIP” (Work in Progress) in the subject line. You can always add more commits later.
    • Read details for open a Pull request

How can I join the mailing list and participate in an ongoing conversation?

The mailing list works via a Google group, so by joining the group you will get new messages and will be allowed to post.

We also have a slack where channels (commonly corresponding to groups/topics/projects) are created and people can join and contribute to the discussion.

How can I offer dataset and other compute resources? What are the data protection policies?

People are pointing to data or offering compute resources via email. A dedicated wiki entry will include more details on the known/available data and compute resources.

How can I use dataset and other compute resources?

We have community-based list of available datasets and tools as well as a list of computing resources. Please visit those pages for more information.

What data protection policies and licenses are applied?

  • As different datasets, tools and resources will be used, we, therefore, encourage you to double-check for any limitations the data and tools you are using. Wherever possible please document those limitations and how you are troubleshooting those issues within your team.
  • A lot of freely available and open access initiatives have been put in place as a way to contribute to solutions around COVID-19. If the dataset/tool you want to use has any restrictions, please contact the responsible team/owner. If the owners can not relax their regular policies/licenses for the use in this hackathon, please find an alternative data/tool to use. Make sure that you document these restrictions to be shared with your team members and anyone who would like to join your team during the hackathon or use your work afterwards.

Are there more ways to participate?

Other than joining the conversation and contributing to any of the topics, you can also offer additional compute support, or data or tools. For instance, ELIXIR Europe and Galaxy have kindly agreed to contribute with cloud resources, servers and others. See the section above related to datasets and compute resources.

Do you have other ideas for contributions? Contact the organisers Leyla Garcia (email: ljgarciaco@gmail.com), Pjotr Prins (email: pjotr.public708@thebird.nl) and Tazro Ohta (email: t.ohta@dbcls.rois.ac.jp)