Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 4.31 KB

CONTRIBUTING.md

File metadata and controls

73 lines (47 loc) · 4.31 KB
Raw

Contributing to this repository

Table of Contents

Introduction

This document describes how you can contribute to the development of onboarding materials for establishing a Federated European Genome-phenome Archive (FEGA) nodes by suggesting or requesting changes to the materials via GitHub (GH). The goal is for these materials to continue evolving over time while the Federated EGA Network is being established, making use of knowledge and expertise across the FEGA nodes. All contributions are welcome, and we aim to make contributing as easy as possible!

What is in this document?

  • Guidelines for requesting changes to FEGA onboarding materials via GH issues
  • Guidelines for proposing changes to FEGA onboarding materials via GH pull requests
  • Guidelines for reporting bugs

Who should be reading this document?

  • Anyone contributing to establishing a FEGA node in their local jurisdiction
  • Anyone interested in improving onboarding materials for establishing a FEGA node

What isn't in this document?

  • Training materials for using FEGA services (e.g. data discovery, data submission, data access). (Coming soon!)
  • Onboarding materials for establishing a FEGA node. This information can be found here.

Requesting changes to FEGA onboarding materials

To request changes to FEGA onboarding materials, follow the steps below:

  1. Gather information for the requested change. There are two main types of requests: (1) for updates to existing materials and (2) for addition of new materials. To request either type of change, the following pieces of information are required:

    1. The website URL or GitHub repository path of the page where the requested update/new material is to be located
    2. The requested update/new materials, including as much detail as possible
    3. Why the update/new material is being requested, including what the added value is

  2. Submit a request for the change. Anyone can request changes to the onboarding materials by creating a GH issue in this repository using this "Request change" GH template. Follow the template to include the information indicated in Step 1. Please add the "requested-change" label to the issue.

  3. Track progress of the request. The request will be reviewed by members of the FEGA community. Clarification may be requested. A proposed change will be made (via a GH pull request) to address the request and will be reviewed by the FEGA community. Once the change is accepted, the pull request will be merged and the related issue will be closed.

Example request for changes to FEGA onboarding materials

Coming soon!

Proposing changes to FEGA onboarding materials

To propose changes to FEGA onboarding materials, follow the steps below:

  1. Create a fork of this repo.

  2. Create a new branch in your local fork for the change(s) you would like to propose. We suggest one type of change per branch.

  3. Make the changes you would like to propose.

    1. Coming soon! Guidance and templates for creating new content.

  4. Open a pull request from your local branch to the main branch of this repo. Request reviewers and add labels to the PR.

    1. Coming soon! Template for creating a PR.

  5. Track progress of PR. Once the PR is accepted, a repo maintainer will merge it.

    1. Coming soon! PR acceptance criteria.

Reporting bugs

Report any bugs by creating an issue using the "Bug report" GH template. Please add the "bug" label to the issue. Example bugs that can be reported include:

  • Dead or broken links
  • Typos or grammar mistakes
  • Missing images

Attribution

We would like to keep track of who has contributed to these onboarding materials, as we consider this a highly valuable contribution to the FEGA community. If you contribute, please add your name to the CONTRIBUTORS.yaml file as part of a PR.