Skip to content

Commit

Permalink
Merge pull request #3 from eco4cast/readme-doc
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
sea-scope authored Jun 10, 2024
2 parents cfe3b55 + 7a9c46c commit 6a20f1e
Showing 1 changed file with 80 additions and 2 deletions.
82 changes: 80 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,80 @@
# efi-ci-workshop-2024
Collection of materials for EFI Ecological Forecasting Cyberinfrastructure Workshop 2024
# EFI CI Workshop 2024

Welcome to the EFI CI Workshop 2024 repository! This repository is dedicated to developing and refining cyberinfrastructure design for ecological forecasting. This guide will help you contribute to the repository.

## Table of Contents

- [Introduction](#introduction)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Contributing](#contributing)
- [How to Contribute](#how-to-contribute)


## Introduction

This repository is a collaborative space for the EFI community to design, discuss, and refine cyberinfrastructure (CI) for ecological forecasting. We welcome contributions from all backgrounds and levels of experience.

## Getting Started

### Prerequisites

Before you start, you will need:

- A GitHub account. You can sign up for one [here](https://github.com/join).
- Git installed on your computer. Follow the instructions [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) to install Git.
- Basic knowledge of Git and GitHub. If you're new to these, we recommend this [tutorial](https://docs.github.com/en/get-started/start-your-journey/hello-world).

### Installation

1. **Fork the repository**

Click the "Fork" button at the top right of this page to create a copy of this repository under your GitHub account.

2. **Clone your fork**

```bash
git clone https://github.com/YOUR-USERNAME/efi-ci-workshop-2024.git
```

3. **Navigate to the repository directory**

```bash
cd efi-ci-workshop-2024
```

4. **Create a new branch**

```bash
git checkout -b your-branch-name
```

## Contributing
### How to Contribute

1. **Find an issue or task**

Check the [Issues](https://github.com/eco4cast/efi-ci-workshop-2024/issues) tab to find tasks that need to be completed or discussions that need your input. You can also create new issues or suggest improvements.

2. **Work on your task**

Once you've selected an issue, start working on it in your forked repository. Make sure to keep your changes focused and relevant to the task at hand.

3. **Commit your changes**

```bash
git add .
git commit -m "Brief description of your changes"
```

4. **Push your changes to your fork**

```bash
git push origin your-branch-name
```

5. **Create a Pull Request**

Go to your forked repository on GitHub, and you should see a "Compare & pull request" button. Click it and follow the instructions to submit your pull request.

0 comments on commit 6a20f1e

Please sign in to comment.