Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

98 lines (64 loc) · 2.52 KB
Raw

Contributing to Research Computing Use-Cases Repository

Table of Contents

  1. Introduction
  2. Getting Started
  3. Creating a New Use-Case
  4. Template for Use-Case
  5. Troubleshooting & FAQ

Introduction

Thank you for considering contributing to our Research Computing Use-Cases repository. This guide outlines how you can contribute a new use-case Readme.md file that follows the repository's standard.

Getting Started

Prerequisites

  • Familiarity with Markdown.
  • Basic understanding of cloud computing and the service for which you are creating the use-case (GCP, AWS, etc.)
  • Installed software:
    • Git
    • Text editor (e.g., VS Code, Sublime Text)

Fork & Clone the Repository

  1. Fork this repository.
  2. Clone the forked repository to your local machine.

Creating a New Use-Case

Steps

  1. Branch: Create a new branch named as use-case/your-use-case-name.
  2. Directory: Navigate to the use-cases/ directory.
  3. New Folder: Create a new folder for your use-case.
  4. Readme.md: Inside this folder, create a Readme.md file.
  5. Content: Populate the Readme.md file using the template below.
  6. Commit: Commit your changes.
  7. Push: Push the changes to your fork.
  8. Pull Request: Create a pull request against the main repository for review.

Template for Use-Case

# Use-Case - Your Use-Case Title Here

## Step-by-Step Instructions

### Step 1 - Title for Step 1

- Detailed instructions for Step 1.

### Step 2 - Title for Step 2

- Detailed instructions for Step 2.

... (Add more steps as needed)

#### Code Blocks

Insert code blocks where needed. For example:

```bash
echo "Hello, World!"

Troubleshooting

  • Issue: Description of the issue.
    • Solution: Solution to resolve the issue.

Best Practices:

  • List any best practices related to this use-case.

---

## Troubleshooting & FAQ

- **Q**: I'm not sure how to write Markdown.
  - **A**: You can refer to this [Markdown Guide](https://www.markdownguide.org/).

- **Q**: How do I test my `Readme.md` file?
  - **A**: You can use online Markdown editors like [Dillinger](https://dillinger.io/) to preview your Markdown file.

- **Q**: Who do I contact if I have questions?
  - **A**: You can create an issue in the repository, and someone will assist you shortly.

---

Thank you for contributing to the Research Computing Use-Cases Repository!