Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ripdrive/ripdrive

This is an open-source fiction project (the first of its kind that we know of). Anyone can submit their ideas, changes and edits.
https://github.com/ripdrive/ripdrive

fiction obsidian obsidian-md quartz-ssg worldbuilding writing

Last synced: 8 days ago
JSON representation

This is an open-source fiction project (the first of its kind that we know of). Anyone can submit their ideas, changes and edits.

Awesome Lists containing this project

README

        

![banner](https://github.com/ripdrive/ripdrive/assets/70611435/fe24921c-1c8c-407a-8d49-da40964bd624)

# The Rip Drive Project

Welcome to The Rip Drive Project.

This is an open-source fiction project (the first of its kind that we know of). Anyone can submit their ideas, changes and edits.

Rip Drive is a Sci-fi universe centered around two kids whose parents go into hiding to keep their reinvention of the [[Rip Drive|rip drive]] from falling into the hands of a powerful space pirate group.

In the prequel era, a group of about a thousand researchers and explorers go on an experimental "rip drive" ship and get stuck lightyears away from earth due to a mutiny on the ship that destroys the drive.

## How to Contribute

### Method 1 (for beginners):

1. **Navigate to the File**:

- Go to the file you want to edit within your repository.
- Click on the file name to open it.

2. **Edit the Content**:

- Click the pencil icon (Edit this file) in the top-right corner.
- Make your changes directly in the editor.

3. **Commit Changes**:

- Click on the “Commit changes” button at the top right.
- Add a meaningful commit message describing your changes. For example: `Add details about the rip drive's inventor`
- Click the “Commit changes” button.

4. **Create a Pull Request (PR)**:

- Open a pull request from your branch to the original repository.
- Describe your changes in the PR and submit it for review.
### Method 2 (for long-term contributors):

> [!NOTE]
> You will need to download [Obsidian](https://obsidian.md/download) and [Git](https://git-scm.com/downloads) if you don't have them installed.

1. **Fork the Repository**: Start by forking this repository to your own GitHub account.

2. **Create a New Branch**: Before making any changes, create a new branch for your work. Use a descriptive name that reflects the content you’re adding or modifying.

3. **Clone the Repository**: Clone the forked repository to your local machine using `git clone https://github.com/ripdrive/ripdrive.git`.

4. **Add Your Content**:
- We use Obsidian to edit our content. Open the repository as an Obsidian Vault.
- If you’re adding new content, create a new Markdown file (`.md`) in the appropriate Folder. Use clear headings and organize your notes logically.
- If you’re modifying existing content, edit the relevant Markdown files. Be sure to maintain consistency with the existing style.
- Once you have opened the repository in Obsidian, open the Source Control view. The button should be in the top right corner of Obsidian when you have the right side panel open.

5. **Stage and Commit Your Changes**: Stage your changes with the plus icons in the source control view. Commit your changes using the checkmark icon and include a meaningful commit message describing your changes. For example: `Add details about the rip drive's inventor`

6. **Push to Your Fork**: Push your changes to your forked repository on GitHub using the upload icon in the source control view.

7. **Create a Pull Request (PR)**:
- Go to the original repository (the one you forked from) on GitHub.
- Click on “New Pull Request.”
- Select your branch and provide a brief description of your changes.
- Our team will review your PR, offer feedback, and merge it if everything looks good.

## Guidelines

- **Markdown Format**: Use Markdown for all your notes. Obsidian vaults also support Markdown, so it’s a seamless transition.
- **Be Consistent**: Follow the existing structure and conventions. Consistency makes navigation easier for everyone.
- **Link Sources**: If you’re referencing other existing material, provide proper links using Obsidian's internal link format: `[[Example Link]]`
- **Respect the Lore**: Our universe has its rules and lore. Ensure your contributions align with the established canon.

> [!TIP]
> If you have questions, ideas, or want to discuss anything related to The Rip Drive Project, feel free to open an issue or join our community discussions.