Skip to content

Latest commit

 

History

History
45 lines (23 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

45 lines (23 loc) · 2.49 KB
Raw

Information

This repository is for a WIP EmuDeck Wiki using MkDocs: https://www.mkdocs.org/

The theme is mkdocs-material: https://github.com/squidfunk/mkdocs-material

The EmuDeck Wiki Website: emudeck.github.io

This repository is not for the EmuDeck application, you can find that here: https://github.com/dragoonDorise/EmuDeck/issues. If you are having any issues with the EmuDeck application, emulators or tools, use the EmuDeck Discord for support. If you have any feedback on the EmuDeck application, open an issue on the aforementioned repository.

How to Contribute

You can contribute to the EmuDeck Wiki in a couple of ways.

Option 1: A quick shout-out

Send a quick message on EmuDeck's Discord stating what needs to be edited or added.

EmuDeck Discord Link

Option 2: Opening an Issue

You will need to create a GitHub account to open an issue.

Once you have created an account, you can visit this page: https://github.com/EmuDeck/emudeck.github.io/issues and submit an issue.

Option 3: Editing the Markdown files

You will need to create a GitHub account to open a Pull Request.

Markdown is a fairly straightforward markup language. If you are not familiar, you can take a quick look at the documents in the docs folder.

Depending on your comfort level with GitHub, you can either use GitHub's web editor to edit any markdown files or you may also clone the repository and edit the markdown files that way.

To edit markdown files in GitHub's web editor, open a document in the docs folder, and click the small pencil icon in the top right. Once you are finished, click Commit changes... GitHub will prompt you to open a Pull Request, which will then be merged once it is reviewed.

Once the PR is merged and reviewed, your changes will automatically be deployed to the website.

If you do choose to clone the repository, you only need to clone the main branch.

Depending on your permission level, when you are finished making edits, either push your changes to main or create a Pull Request. Any changes you make to the markdown files will automatically be pushed to the gh-pages branch and deployed to the website once you have either pushed your changes to main or your Pull Request is approved and merged.

Thank you for contributing!