Thank you for showing interest in the development of Rūrusetto. This guidelines below is a guidelines. There are not "official rules" or something like that, but following them will help everyone deal with things in the most efficient manner.
Typo in wiki, bug reports and feature suggestion are welcomed. Or you are a developer that make a new osu! ruleset and it's not appear in this website you can submit an issue too!
You can contribute this website in many ways! So it's have 2 big ways. Before we go longer, here is some key things before get started.
-
Make sure to keep the Allow edits from maintainers check box checked. To speed up the merging process, sometimes collaborators want to push some change to your pull request. So, having the Allow edits from maintainers checkbox checked lets maintainers do that; without it maintainers are forced to report issues back to you and wait for you to address them.
-
Refrain from continually merging the main branch back to the pull request. Please refrain from continually merging the
mainbranch unless there are merge conflicts that need resolution. One of the maintainers will mergemainbranch themselves before merging the pull request itself anyway. -
Refrain from force-pushing to the pull request. Force-pushing should be avoided, as it can lead to accidentally overwriteing a maintainer's changes. The case in which force-pushing is warranted are very rare (such as accidentally leaking sensitive info in one of the files committed, adding unrelated files, or mis-merging a dependent pull request).
You are web developer? Let's start technically about this website! This website build by using Hugo framework and publish using Netlify. A main structure of this website is like this.
rurusetto
|
|-- archetypes # Markdown file theme when you use Hugo command line to generate a new page
|
|-- content # Main website content
| |
| |- pages # Page in header menu or more page in this website
| |
| |- posts # Contain all ruleset pages
|
|-- data
|
|-- layouts # Hugo config when you want to customize something during build.
|
|-- resources # Resources use for build a website
|
|-- themes
|
|- hugo-cards # Main HTML and SCSS file are here.
You can learn more about Hugo Cards from a theme repo. You want to override CSS style? You can use custom.css file to custom more CSS style.
Don't worry! You can contribute in many ways!
This website mainly formatted using Markdown specifically GitHub-Flavoured Markdown (GFM), a markup language that allows for text to have basic styling. Cannot remember all style command? This cheat sheet can help you!
Since this website is entirely in this GitHub repositories, you will need some basic knowledge of Git in order to contribute. You can use GitHub Desktop to make a pull request easier.
Get in content/posts directory. Make a new folder with a ruleset name. A structure in each ruleset page folder is like this.
ruleset-folder-page
|
|-- index.md # This is a main markdown file.
|
|-- ruleset-logo.png # Ruleset logo. Size must be 1200 x 750 px and must be a transparent PNG.
|
|-- mod-icon # Picture folder contain all mod icon. You can put other picture to if you have more picture than mod icon.
|
|-- blablabla-mod.png # Mod icon require 20 x 28 px and must be a transparent PNG.
An index.md file header must be like this.
---
title: "sentakki" # ruleset name. No capitalized.
img: "ruleset-logo.png" # Ruleset logo PNG file
date: 2021-04-17 # Latest build release date
summary: "Summary on the front post"
---Due to a font that use in this website. The header must be no capitalized. Please follow page structure from other ruleset pages.
You can go to your pull request post and click this button to open preview mode. It will update everytime you commit and push a code.
That's all. If you have any problem, you can leaving a comment in the relevant issue or pull requests, or use development server. We will try to help you as much as we can.