https://github.com/dkniffin/pota-remix
https://github.com/dkniffin/pota-remix
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dkniffin/pota-remix
- Owner: dkniffin
- Created: 2021-02-13T02:05:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-13T04:32:09.000Z (over 4 years ago)
- Last Synced: 2025-02-02T03:43:09.905Z (4 months ago)
- Size: 107 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Princes of the Apocalypse Remix
This repo is home to a project that aims to rewrite, improve and expand upon the Princes of the Apocalypse campaign for 5e Dungeons and Dragons.
## How Can I Use It?
Currently, the project is still very much a work in progress. You can view the raw markdown via the file navigator above. Eventually we will publish it in a more user friendly way. To follow the changes being made here, you can click "Watch" in the top right and you'll get notifications based on the preferences in your Github account.
## Campaign Markdown
The text for the campaign is written in Homebrew flavored Markdown](https://guides.github.com/features/mastering-markdown/).
## Contributing
All ideas and contributions to this project are welcome!
### Ideas as Github Issues
If you'd like to share an idea, please do so in the form of a Github Issue:
- Click the "Issues" tab up above
- Search for some key words to see if someone has already suggested your idea
- If they have suggested your idea, add a 👍 reaction to the initial post, as a sort of informal vote for that idea. Alternatively, join in the conversation and provide your thoughts and feedback
- If you can't find an issue that matches your idea, click "New issue" to create a new one. Add as much detail as it takes to get your idea across. The posts are created using [Markdown](https://guides.github.com/features/mastering-markdown/), so feel free to include supporting images, links to spots in the campaign markdown, or whatever else you feel is necessary.
### Changes as Pull Requests
**NOTE: For now, only pull requests that are making formatting updates to match the book will be accepted. Revisions, improvements and extensions will come later once the markdown accurately reflects the printed book.**
If your idea is detailed enough that you'd like to provide it in the form of a change to the campaign markdown, you can create a pull request. However, before doing so, it's probably a good idea to create a Github issue first, to make sure everyone else is onboard with your idea. To create a pull request:
**Option 1 (for those familiar with git):**
- Fork this repo
- Clone down the fork
- Make your changes in your editor of choice
- Commit your changes to a branch and push it up to your fork
- Navigate to the "Pull requests" tab
- Create a pull request from your branch to the main branch
**Option 2 (for those unfamiliar with git):**
*Note: if you want to make changes to more than one file, you'll need to use Option 1.*
- Find the file you would like to edit in the file tree above
- Click on pencil icon in the top right
- Make your changes in the markdown editor. You can use the "Preview changes" tab to see if you've formatted everything correctly.
- Once your change is complete, in the top line of the commit changes box, add a brief summary of your change. You can use the larger input box to add additional details.
- Select the "create a new branch" radio and name it whatever you want
- Click "Propose changes"
Once the pull request is created, one of the main contributors will review it and give feedback. Once it's ready to go, it will be merged into the code, which means it will be live in the campaign!