CONTRIBUTING
We welcome contributions from the speedrunning community to help improve and expand this wiki. If you have new techniques to document, additional scene information, or corrections, please feel free to contribute
How to Contribute
TIP
You can simply click on Edit this page at the footer of any page and start editing it.
Right now there are a few ways of contributing to the project:
- Reporting issues and suggesting features on GitHub Issues
- Contributing via Pull Requests
- Improves the overall design of the page
- Upload you runs to speedrun.com, since it is one of the main sources of footage for this guide
Github Issues
You can open a issue to send a question, request a feature or notify any mislead information. Please follow the designated templates
Pull Requests
By doing a pull request you can modify a section, add new information to the guide, etc. To do so, follow this steps:
Fork this Repository: Begin by creating a fork of this repository in your own GitHub account. This will create a copy of the project in your profile.
Understand the Format: Carefully read through the project to understand how it is built. It is intuitive to navigate since site reflects directory hierarchy and everything is a bunch of markdown files.
Modify or Create a New File: You can either modify an existing file or create a new Markdown (.md). Ensure that you adhere to the provided format and guidelines.
Commit and Push: After making the necessary changes, commit your modifications and push them to your branch in your forked repository.
Create a Pull Request: Visit the Pull Requests page of this repository and click on "New Pull Request." Select your fork's branch and the project's main branch to compare the changes. Provide a clear title and description to explain your modifications.
Await Review: Upon creating the Pull Request, wait for project maintainers to review your submission. Be prepared to make adjustments as needed based on the feedback received.
Overall design
You can improve the favicons and anything you think can improve the overall aspects of the project. Pay attention this is built onto an opinionated framework to ensure simplicity, as the overall goal is to document speedrun tricks.
Please ensure that all contributions adhere to our style guidelines. If you're unsure about anything, feel free to ask us in
Contributions are highly welcomed, and we appreciate your assistance in improving this speedrun guide!