Skip to content

Latest commit

 

History

History
85 lines (62 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

85 lines (62 loc) · 2.85 KB
Raw

Development

You only need to follow the below instructions if you are trying to modify this software. Otherwise, please download the latest version from the github releases.

Server code is located at OhMyGuus/BetterCrewLink-server. Please use a local server for development purposes.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

npm install yarn -g

Setup

  1. Clone the repo
git clone https://github.com/OhMyGuus/BetterCrewLink.git
cd BetterCrewLink
  1. Install NPM packages
yarn install
  1. Run the project
yarn dev

Contributing

Contributors

Any contributions you make are greatly appreciated.

Needed Git for Contributing.

  1. Fork the Project.
  2. Create your Feature Branch. (git checkout -b feature/AmazingFeature)
  3. Commit your Changes. (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch. (git push origin feature/AmazingFeature)
  5. Open a Pull Request.

Translating

Crowdin

BetterCrewLink now officially supports other languages, that is, you can use BetterCrewLink without any problem of not understanding a part in English, but with that we need help with translations because nobody is born knowing everything languages.

Any translations you make are greatly appreciated.

There are two methods.

In GitHub
  1. Fork the Project.
  2. Create your Translation Branch.
  3. Go to static -> locales -> en -> translation.json and Download this file.
  4. Open the translation.json with your text editor of preference.
  5. Edit the file but not edit this parts like: "gamehostonly", "inlobbyonly", just translate the text.
  6. Create a folder with the acronym of your language that you translated with translation.json inside the folder.
  7. Throw everything to your fork.
  8. Open a Pull Request.
In Crowdin
  1. Go to Crowdin Page.
  2. Search for the name of your language you want to translate.
  3. Click on it and start translating.