Nosana Jobs Templates

This repository contains job definition file templates that can be used to post jobs to the Nosana Network.

Templates

• Hello World
• Jupyter Notebook
• Open WebUI
• Stable Diffusion

Contribution Guide

Thank you for your interest in contributing to our repository! By adding your own job definition templates, you’re helping to build a valuable resource for the Nosana Network community.

Follow the steps below to submit a Pull Request (PR) with a new template:

1. Fork the Repository

1. Go to the repository page on GitHub.
2. Click on the "Fork" button in the upper-right corner to create your own copy of the repository.

2. Clone the Forked Repository

After forking, clone your copy to your local machine:

git clone https://github.com/your-username/templates.git
cd templates

3. Create a New Branch

Create a new branch for your template submission:

git checkout -b add-template-your-template-name

4. Add Your Template

Create a new folder for your template inside the templates directory. Each template folder must contain the following files:

4.1 info.json

This file should provide basic information about your template using the following structure:

{
  "id": "your-template-id",
  "name": "Your Template Name",
  "description": "A brief description of what the template does",
  "category": ["Your Category"], 
  "icon": "https://link-to-an-icon-for-your-template"
}

• id: A unique identifier for your template.
• name: The name of the template.
• description: A concise description of what the job does.
• category: Relevant categories (can be multiple).
• icon: A URL link to an icon (e.g., a logo or related image).

4.2 job-definition.json

This file should contain the job definition JSON. Refer to the Nosana Documentation for details on writing a job definition file.

4.3 README.md

Include a README.md file with the following:

• Title: The name of your template.
• Description: A detailed description of the template, how it works, and any requirements.
• Screenshot/Video: Add an image, screenshot, or video showing the result of using your template (optional but encouraged). Make sure to only use absolute URLs.

Example README.md:

# Your Template Name

## Description
A brief explanation of what the template does and how it works.

## Screenshot/Video
![Screenshot](https://link-to-screenshot)

5. Commit Your Changes

After adding your template, commit your changes:

git add .
git commit -m "Add new template: your-template-name"

6. Push Your Branch

Push the branch to your forked repository:

git push origin add-template-your-template-name

7. Open a Pull Request

1. Go to your forked repository on GitHub.
2. Click the "Compare & pull request" button.
3. Submit the pull request for review.

---

Contribution Guidelines

• Ensure that the info.json and job-definition.json files are properly formatted and contain all necessary information.
• Make sure your README.md is clear, descriptive, and includes a screenshot or video (if available).
• Test your job definition to ensure it works as expected.
• Make sure your PR only contains the necessary files for your template.

We appreciate your contribution! Once your PR passes the validation tests, is reviewed, and approved, it will be merged into the main repository.