Skip to main content

General Guidelines

In order to contribute to any project, you may make a pull request to its related repositories. Regardless of the contributor's status (member or not), a pull request must fulfill the following conditions in order to be accepted:

Projects​

note

Archived repositories and resources are not included in this documentation!

info

GitHub projects have a naming scheme that follows these rules:

  • If the repository contains the root directory of a subdomain, it's prefixed with the string: "wrr-"! (web root repository)
  • If the repository contains extra website(s) build files, it's prefixed with the string: "wre-"! (web root extras)
  • Otherwise, the repository will not include a prefix!

Here is a list of all projects, including their status and relevant resources:

Main Website​

  • Status: In progress
  • Website(s): ender.ing, terminal.ender.ing
  • Description: Most of the website's resources are under this project, except for project-specific pages!
  • GitHub Projects: none
  • GitHub Repositories:
    • /wrr-www: Holds all basic root files (www subdomain, root domain)
    • /wrr-mta-sts: Holds files related to the mailing setup (mta-sts subdomain)
    • /wrr-terminal: Holds resources related to the server's (exposed) web terminal, which is used to maintain the website! (terminal subdomain)
    • /wre-secrets (private): Contains web-related secrets!
    • /host (private): Used to keep track of web server file updates

Juggernyaut​

  • Status: In progress
  • Website(s): ender.ing
  • Description: An experimental general-purpose programming language in the making!
  • GitHub Projects: none
  • GitHub Repositories:

Style Guides​

A style guide covers a set of instructions as to how to write code, comments, and other unique requirements. These instructions are meant to make collaboration between a wide range of different developers more uniform and easy.

Each project may use its own set of programming languages. Generally, each used language has its own style guide:

Content Guide​

A content guide defines what is to be considered valid content, depending on the type of said content.

Client Content​

All content meant to be served in user-friendly settings (e.g. website UI) falls under the following guidelines:

  • Content must be served in Standard English.
  • Content language translations should be done by hand! You are not allowed to use non-proofread machine-generated translations!
  • Illustrations and UI design should follow a consistent design!

Developer Content​

All content meant to be seen only by developers (an API response, commands, etc.) falls under the following guidelines:

  • Content must served only in English!

It is important to make sure that your contributions are not breaking any existing copyright agreements or licensing!

Contributions - code or assets - that are covered by licensing/copyright should be covered by a license/agreement that explicitly allows freedom of use, and does not impose any charges/costs.

By default, you retain your rights to self-made contributions. By contributing code or assets, it is assumed that you are allowing unconditional free use of your contribution, free of charge.

Code​

You may express your wishes or insert any legal text regarding contributed code using comments, according to the applicable style guidelines!

Assets​

You may express your wishes or insert any legal text regarding contributed assets by adding them to a LEGAL file in the directory that holds your contribution.

The contents of a LEGAL file (just LEGAL, in capital letters, without any extension) should be as follows:

-RESOURCE-NAME: <item>
-RESOURCE-NAME: <item>
...
-RESOURCE-LEGAL-TEXT
<legal-text>
  • <item>: The file name (including the extension) within the directory. You may use an asterisk (*) to cover all files within the current directory under a license/copyright/note.
  • <legal-text>: The contents of the license/copyright/note

A clear example:

-RESOURCE-NAME: image.png
-RESOURCE-LEGAL-TEXT
Copyright (c) 2024 Your Name
This software is licensed under the MIT License


-RESOURCE-NAME: file1.png
-RESOURCE-NAME: file2.png
-RESOURCE-NAME: file3.png
-RESOURCE-LEGAL-TEXT
Copyright (c) 2024 Some Company
This software is licensed under the MIT License