Code Monkey home page Code Monkey logo

github-guidebook-for-ambassadors's Introduction

GitHub-Guidebook-for-Ambassadors

Instructions and help for using the eLife Ambassadors GitHub organisation

What is GitHub?

GitHub offers a way to collaborate on projects with a distributed team of people working online, or just work on projects by yourself!

It's a useful platform to use to host your files and manage your collaborative work online.

GitHub was first designed for open source software development. GitHub is platform that is designed to work using git – git is a coding method for version control. You don't need to know or use git to use GitHub.

And you don't need to code to use GitHub. Many people use Github for working on non-code content, and that’s ok! It's a really powerful tool for project work.

GitHub offers a nice user interface for working with git, and it adds some really handy features, from conversations in Issues, and a way to offer and receive suggested changes, and use peer review before suggestions are accepted.

With GitHub, you can easily make a free basic website for your project, and include fun things like emojis and GIFs in your homepage.

Here are some examples of GitHub being used for projects about collaboration, openness, diversity and inclusion in the life sciences:

About the eLifeAmbassadors GitHub organisation

The eLife Ambassadors have a non-profit account on GitHub, which means we can host a repository for you within this eLifeAmbassadors organisation (homepage: https://github.com/eLifeAmbassadors) and you can maintain public and private repositories for free.

The eLife Ambassadors GitHub organisation is a place where we can collect all content that eLife Ambassadors wish to share with Ambassadors and others outside the programme using GitHub. This helps everyone to find things and keep things tidy: Keeping your project in this organisation will help your work be discoverable to others – we'll need only to point people to this GitHub and they'll see all your projects in one place. Members of the organisation (i.e. other ambassadors and any collaborators) can view private repositories. Anyone on the internet can view public repositories.

In this guide, you’ll find the basic guidelines for how we use and manage the eLife Ambassadors GitHub organisation.

How can I find help to get started?

Two training workshops will run in May 2020.

Training workshop agenda and notes: link to be added Supporting documentation to support activities: https://github.com/eLifeAmbassadors/developing_collaborative_document

Who can help me participate in the eLife Ambassadors GitHub organisation?

The admins of this organisation are:

  • Naomi @npscience, eLife Community Manager
  • Lotte @lottedewinde, eLife Early-Career Advisory Group
  • Shyam @smsaladi, eLife Early-Career Advisory Group
  • Devang @devang-mehta, eLife Early-Career Advisory Group
  • Aziz @asntech, eLife Ambassador
  • Vivek @vivekbhr, eLife Ambassador

A governance structure, and clear roles, are TBD

eLife maintain this account's billing and should be primary contact for account issues and reports of violations of the eLife Ambassadors Code of Conduct (available from the community's Discourse forum).

What can I do here?

Become a member

Before you can contribute into this organisation, you need to apply to become a member. All eLife Ambassadors, Associates, and verified external contributors to Ambassador projects, can become a member.

  1. (If not already done) Sign up for a GitHub account: to use GitHub beyond browsing and clicking, you’ll need an account (which is free as in $¥€£ 0, see pricing) – you can sign up at https://github.com/join.
  2. Apply to join this organisation by posting a reply to this Issue thread – you need to be signed into the GitHub account that you wish the invite to be sent to.

Add your work here

  1. Transfer an existing repository into this organisation account: instructions WIP
  2. Create a new repository in this organisation: instructions WIP

Follow good-enough practices

Recommended practices for:

  • repository organisation: instructions WIP
  • collaborating here: instructions WIP

Give back

  • Contribute to this guide: instructions WIP
  • TODO: Add a governance structure

github-guidebook-for-ambassadors's People

Contributors

npscience avatar

Stargazers

 avatar

Watchers

 avatar  avatar

github-guidebook-for-ambassadors's Issues

Request an invite to this GitHub organisation

To request an invite to this organisation, so you can create, contribute to and transfer repositories into here, please reply to this issue thread.

I'll use your github username to send you an invite.

I'll actively monitor invite requests until at least June 5, 2020.
[After that time, we'll update this issue thread with any change in process :)]

Third-party application access to private data in this organisation's repos

For users to link GitHub to third-party tools, such as the OSF, admins here need to approve these third-party applications so that they can request access to private data in this organisation's repo. These decisions affect all private data in this oerganisation, they cannot be made at the level of individual repos.

We need a way to document approvals, and decide these things in a way that all private repo owners can be aware and provide input.

For now, I'm setting up this issue thread to record the first instance of this happening.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.